axiansdeveloper.ipfabric.inventory (0.0.3) — inventory

Install collection

Install with ansible-galaxy collection install axiansdeveloper.ipfabric:==0.0.3

Add to requirements.yml

  collections:
    - name: axiansdeveloper.ipfabric
      version: 0.0.3

Description

Get inventory from IPFabric

Inputs

    
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

token:
    description:
    - IPFabric API
    env:
    - name: IPFABRIC_TOKEN
    required: true

plugin:
    choices:
    - axiansdeveloper.ipfabric.inventory
    description: token that ensures this is a source file for the 'ipfabric' plugin.
    required: true

plurals:
    default: true
    description:
    - If True, all host vars are contained inside single-element arrays.
    - Group names will be plural (ie. "sites_mysite" instead of "site_mysite")
    - The choices of I(group_by) will be changed by this option.
    type: boolean

timeout:
    default: 60
    description: Timeout for IPFabric requests in seconds.
    type: int

group_by:
    choices:
    - family
    - platform
    - platforms
    - site
    - sites
    - vendor
    - vendors
    default: []
    description: Keys used to create groups.
    type: list

snapshot:
    default: $last
    description: Snapshot ID
    type: str

api_endpoint:
    description: Endpoint of the IPFabric API.
    env:
    - name: IPFABRIC_API
    required: true

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

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

validate_certs:
    default: true
    description:
    - Allows connections when SSL certificates are not valid. Set to C(false) when certificates
      are not trusted.
    type: boolean

group_names_raw:
    default: false
    description: Will not add the group_by choice name to the group names
    type: boolean

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