networktocode / networktocode.nautobot / 4.5.0 / inventory / gql_inventory Nautobot inventory source using GraphQL capability Authors: Network to Code (@networktocode), Armen Martirosyan (@armartirosyan)networktocode.nautobot.gql_inventory (4.5.0) — inventory
Install with ansible-galaxy collection install networktocode.nautobot:==4.5.0
collections: - name: networktocode.nautobot version: 4.5.0
Get inventory hosts from Nautobot using GraphQL queries
query: default: {} description: - GraphQL query parameters or filters to send to Nautobot to obtain desired data required: false suboptions: devices: description: - Additional query parameters or filters for devices required: false type: dict virtual_machines: description: - Additional query parameters or filters for VMs required: false type: dict type: dict token: description: - Nautobot API token to be able to read against Nautobot. - This may not be required depending on the Nautobot setup. env: - name: NAUTOBOT_TOKEN required: true plugin: choices: - networktocode.nautobot.gql_inventory description: Setting that ensures this is a source file for the 'networktocode.nautobot' plugin. required: true timeout: default: 60 description: Timeout for Nautobot requests in seconds type: int group_by: default: [] description: - List of dot-sparated paths to index graphql query results (e.g. `platform.slug`) - The final value returned by each path is used to derive group names and then group the devices into these groups. - Valid group names must be string, so indexing the dotted path should return a string (i.e. `platform.slug` instead of `platform`) - 'If value returned by the defined path is a dictionary, an attempt will first be made to access the `name` field, and then the `slug` field. (i.e. `platform` would attempt to lookup `platform.name`, and if that data was not returned, it would then try `platform.slug`) ' elements: str required: false type: list api_endpoint: description: Endpoint of the Nautobot API env: - name: NAUTOBOT_URL required: true validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. type: boolean follow_redirects: choices: - urllib2 - all - 'yes' - safe - none default: urllib2 description: - Determine how redirects are followed. - By default, I(follow_redirects) is set to uses urllib2 default behavior.
_list: description: - list of composed dictionaries with key and value type: list