menandmice.ansible_micetro.inventory (1.0.7) — inventory

Install collection

Install with ansible-galaxy collection install menandmice.ansible_micetro:==1.0.7

Add to requirements.yml

  collections:
    - name: menandmice.ansible_micetro
      version: 1.0.7

Description

Reads inventories from Micetro

Supports reading configuration from both YAML config file and environment variables.

If reading from the YAML file, the file name must be micetro.(yml|yaml), micetro_inv.(yml|yaml) or micetro_inventory.(yml|yaml), the path in the command would be /path/to/micetro.(yml|yaml). If some arguments in the config file are missing, this plugin will try to fill in missing arguments by reading from environment variables.

If reading configurations from environment variables, the path in the command must be @micetro_inventory.

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

mm_url:
    description: The network address of the Micetro host
    env:
    - name: MM_HOST
    required: true
    type: string

plugin:
    choices:
    - menandmice.ansible_micetro.inventory
    description: the name of this plugin, it should always be set to 'menandmice.ansible_micetro.inventory'
      for this plugin to recognize it as it's own.
    env:
    - name: ANSIBLE_INVENTORY_ENABLED
    required: true

ranges:
    description: Ranges to get the inventory from (e.g. 172.16.17.0/24)
    env:
    - name: MM_RANGES
    required: false
    type: list

filters:
    description:
    - A list of filter value pairs.
    - This a combination of a custom property and the value
    - To avoid parsing errors, the custom-key and custom-value are both sanitized, so
      both are converted to lowercase and all special characters are translated to "_"
    env:
    - name: MM_FILTERS
    required: false
    type: list

mm_user:
    description: The user that you plan to use to access inventories on your Micetro
    env:
    - name: MM_USER
    required: true
    type: string

mm_password:
    description: The password for your your Micetro user
    env:
    - name: MM_PASSWORD
    required: true
    type: string

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

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