community / community.general / 2.5.9 / lookup / nios Query Infoblox NIOS objects Authors: Unknown (!UNKNOWN)community.general.nios (2.5.9) — lookup
Install with ansible-galaxy collection install community.general:==2.5.9
collections: - name: community.general version: 2.5.9
Uses the Infoblox WAPI API to fetch NIOS specified objects. This lookup supports adding additional keywords to filter the return data and specify the desired set of returned fields.
- name: fetch all networkview objects ansible.builtin.set_fact: networkviews: "{{ lookup('community.general.nios', 'networkview', provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
- name: fetch the default dns view ansible.builtin.set_fact: dns_views: "{{ lookup('community.general.nios', 'view', filter={'name': 'default'}, provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
# all of the examples below use credentials that are set using env variables # export INFOBLOX_HOST=nios01 # export INFOBLOX_USERNAME=admin # export INFOBLOX_PASSWORD=admin - name: fetch all host records and include extended attributes ansible.builtin.set_fact: host_records: "{{ lookup('community.general.nios', 'record:host', return_fields=['extattrs', 'name', 'view', 'comment']}) }}"
- name: use env variables to pass credentials ansible.builtin.set_fact: networkviews: "{{ lookup('community.general.nios', 'networkview') }}"
- name: get a host record ansible.builtin.set_fact: host: "{{ lookup('community.general.nios', 'record:host', filter={'name': 'hostname.ansible.com'}) }}"
- name: get the authoritative zone from a non default dns view ansible.builtin.set_fact: host: "{{ lookup('community.general.nios', 'zone_auth', filter={'fqdn': 'ansible.com', 'view': 'ansible-dns'}) }}"
_terms: description: The name of the object to return from NIOS required: true filter: description: a dict object that is used to filter the return objects extattrs: description: a dict object that is used to filter on extattrs provider: description: - A dict object containing connection details. suboptions: host: description: - Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST - Value can also be specified using C(INFOBLOX_HOST) environment variable. type: str http_pool_connections: default: 10 description: - Number of pools to be used by the C(infoblox_client.Connector) object. - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class. type: int http_pool_maxsize: default: 10 description: - Maximum number of connections per pool to be used by the C(infoblox_client.Connector) object. - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class. type: int http_request_timeout: default: 10 description: - The amount of time before to wait before receiving a response - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment variable. type: int max_results: default: 1000 description: - Specifies the maximum number of objects to be returned, if set to a negative number the appliance will return an error when the number of returned objects would exceed the setting. - Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment variable. type: int max_retries: default: 3 description: - Configures the number of attempted retries before the connection is declared usable - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable. type: int password: description: - Specifies the password to use to authenticate the connection to the remote instance of NIOS. - Value can also be specified using C(INFOBLOX_PASSWORD) environment variable. type: str silent_ssl_warnings: default: true description: - Disable C(urllib3) SSL warnings in the C(infoblox_client.Connector) object. - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class. type: bool username: description: - Configures the username to use to authenticate the connection to the remote instance of NIOS. - Value can also be specified using C(INFOBLOX_USERNAME) environment variable. type: str validate_certs: aliases: - ssl_verify default: false description: - Boolean value to enable or disable verifying SSL certificates - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable. type: bool wapi_version: default: '2.1' description: - Specifies the version of WAPI to use - Value can also be specified using C(INFOBLOX_WAP_VERSION) environment variable. - Until ansible 2.8 the default WAPI was 1.4 type: str type: dict return_fields: description: The list of field names to return for the specified object.
obj_type: contains: obj_field: description: - One or more obj_type fields as specified by return_fields argument or the default set of fields as per the object type description: - The object type specified in the terms argument type: dictionary