n3pjk / n3pjk.servicenow / 0.0.26 / inventory / now ServiceNow Inventory Plugin | "added in version" 2.10 of n3pjk.servicenow" Authors: Will Tome (@willtome), Alex Mittell (@alex_mittell)n3pjk.servicenow.now (0.0.26) — inventory
Install with ansible-galaxy collection install n3pjk.servicenow:==0.0.26
collections: - name: n3pjk.servicenow version: 0.0.26
ServiceNow Inventory plugin.
host: description: - The ServiceNow hostname. - This value is FQDN for ServiceNow host. - If the value is not specified in the task, the value of environment variable C(SN_HOST) will be used instead. - Mutually exclusive with C(instance). env: - name: SN_HOST required: false type: str cache: default: false description: - Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. env: - name: ANSIBLE_INVENTORY_CACHE ini: - key: cache section: inventory type: bool proxy: default: '' description: Proxy server to use for requests to ServiceNow. type: string table: default: cmdb_ci_server description: The ServiceNow table to query. type: string fields: default: ip_address,fqdn,host_name,sys_class_name,name description: Comma seperated string providing additional table columns to add as host vars to each inventory host. type: list groups: default: {} description: Add hosts to group based on Jinja2 conditionals. type: dict plugin: choices: - servicenow.servicenow.now description: The name of the ServiceNow Inventory Plugin, this should always be 'servicenow.servicenow.now'. required: true strict: default: false description: - If V(yes) make invalid entries a fatal error, otherwise skip and continue. - Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. type: bool compose: default: {} description: Create vars from jinja2 expressions. type: dict enhanced: default: false description: - Enable enhanced inventory which provides relationship information from CMDB. - Requires installation of Update Set located in update_sets directory. type: bool instance: description: - The ServiceNow instance name, without the domain, service-now.com. - If the value is not specified in the task, the value of environment variable C(SN_INSTANCE) will be used instead. env: - name: SN_INSTANCE required: false type: str password: description: - Password for username. - If the value is not specified, the value of environment variable C(SN_PASSWORD) will be used instead. env: - name: SN_PASSWORD required: true type: str username: description: - Name of user for connection to ServiceNow. - If the value is not specified, the value of environment variable C(SN_USERNAME) will be used instead. env: - name: SN_USERNAME required: false type: str cache_plugin: default: memory description: - Cache plugin to use for the inventory's source data. env: - name: ANSIBLE_CACHE_PLUGIN - name: ANSIBLE_INVENTORY_CACHE_PLUGIN ini: - key: fact_caching section: defaults - key: cache_plugin section: inventory type: str cache_prefix: default: ansible_inventory_ description: - Prefix to use for cache plugin files/tables env: - name: ANSIBLE_CACHE_PLUGIN_PREFIX - name: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX ini: - key: fact_caching_prefix section: defaults - key: cache_prefix section: inventory keyed_groups: default: [] description: Add hosts to group based on the values of a variable. elements: dict suboptions: default_value: description: - The default value when the host variable's value is an empty string. - This option is mutually exclusive with O(keyed_groups[].trailing_separator). type: str version_added: '2.12' version_added_collection: ansible.builtin key: description: - The key from input dictionary used to generate groups type: str parent_group: description: parent group for keyed group type: str prefix: default: '' description: A keyed group name will start with this prefix type: str separator: default: _ description: separator used to build the keyed group name type: str trailing_separator: default: true description: - Set this option to V(False) to omit the O(keyed_groups[].separator) after the host variable when the value is an empty string. - This option is mutually exclusive with O(keyed_groups[].default_value). type: bool version_added: '2.12' version_added_collection: ansible.builtin type: list cache_timeout: default: 3600 description: - Cache duration in seconds env: - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT - name: ANSIBLE_INVENTORY_CACHE_TIMEOUT ini: - key: fact_caching_timeout section: defaults - key: cache_timeout section: inventory type: int filter_results: default: '' description: Filter results with sysparm_query encoded query string syntax. Complete list of operators available for filters and queries. type: string use_extra_vars: default: false description: Merge extra vars into the available variables for composition (highest precedence). env: - name: ANSIBLE_INVENTORY_USE_EXTRA_VARS ini: - key: use_extra_vars section: inventory_plugins type: bool version_added: '2.11' version_added_collection: ansible.builtin enhanced_groups: default: true description: enable enhanced groups from CMDB relationships. Only used if enhanced is enabled. type: bool selection_order: default: ip_address,fqdn,host_name,name description: Comma seperated string providing ability to define selection preference order. type: list cache_connection: description: - Cache connection data or path, read cache plugin documentation for specifics. env: - name: ANSIBLE_CACHE_PLUGIN_CONNECTION - name: ANSIBLE_INVENTORY_CACHE_CONNECTION ini: - key: fact_caching_connection section: defaults - key: cache_connection section: inventory type: str leading_separator: default: true description: - Use in conjunction with keyed_groups. - By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. - This is because the default prefix is "" and the default separator is "_". - Set this option to False to omit the leading underscore (or other separator) if no prefix is given. - If the group name is derived from a mapping the separator is still used to concatenate the items. - To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. type: boolean version_added: '2.11' version_added_collection: ansible.builtin