seiko.smartcs.smartcs_facts (1.5.0) — module

Install collection

Install with ansible-galaxy collection install seiko.smartcs:==1.5.0

Add to requirements.yml

  collections:
    - name: seiko.smartcs
      version: 1.5.0

Description

Collects a base set of device facts from a SmartCS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Collect all facts from the device
  seiko.smartcs.smartcs_facts:
    gather_subset: all

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Collect only the config and default facts
  seiko.smartcs.smartcs_facts:
    gather_subset:
    - config

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Do not collect tty facts
  seiko.smartcs.smartcs_facts:
    gather_subset:
    - "!tty"

Inputs

    
provider:
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
    - HORIZONTALLINE
    - A dict object containing connection details.
    suboptions:
      auth_pass:
        description:
        - Specifies the password to use if required to enter privileged mode on the remote
          device.  If I(authorize) is false, then this argument does nothing. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
          will be used instead.
        type: str
      authorize:
        default: false
        description:
        - Instructs the module to enter privileged mode on the remote device before sending
          any commands.  If not specified, the device will attempt to execute all commands
          in non-privileged mode. If the value is not specified in the task, the value
          of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
        type: bool
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote device over
          the specified transport.  The value of host is used as the destination address
          for the transport.
        type: str
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote device.   This
          value is used to authenticate the SSH session. If the value is not specified
          in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will
          be used instead.
        type: str
      port:
        description:
        - Specifies the port to use when building the connection to the remote device.
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH key to use to authenticate the connection to the remote device.   This
          value is the path to the key used to authenticate the SSH session. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
          will be used instead.
        type: path
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          device.  This value is used to authenticate the SSH session. If the value is
          not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME)
          will be used instead.
        type: str
    type: dict

gather_subset:
    default: '!config'
    description:
    - When supplied, this argument restrict the facts collected to a given subset.
    - Possible values for this argument include C(all), C(config) and C(tty)
    - Specify a list of values to include a larger subset.
    - Use a values with an initial C(!) to collect all facts except that subset.
    elements: str
    required: false
    type: list

Outputs

ansible_net_backupsystem:
  description: The operating system version of backup system of the remote device
  returned: always
  type: str
ansible_net_bond1:
  description: The configured bond1 interfaces of the remote device
  returned: always
  type: dict
ansible_net_bootconfig:
  description: The boot config of the remote device
  returned: always
  type: str
ansible_net_bootrom:
  description: The BootROM version running on the remote device
  returned: always
  type: str
ansible_net_config:
  description: The current active config from the device
  returned: when config is configured
  type: str
ansible_net_eth1:
  description: The configured eth1 interfaces of the remote device
  returned: always
  type: dict
ansible_net_eth2:
  description: The configured eth1 interfaces of the remote device
  returned: always
  type: dict
ansible_net_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_hostname:
  description: The configured hostname of the device
  returned: always
  type: str
ansible_net_mainsystem:
  description: The operating system version of main system of the remote device
  returned: always
  type: str
ansible_net_model:
  description: The model name returned from the device
  returned: always
  type: str
ansible_net_serialnum:
  description: The serial number of the remote device
  returned: always
  type: str
ansible_net_tty:
  description:
  - The configured each tty information
  - baud, bitchar, flow, parity, stop, and label
  returned: when tty is configured
  type: list
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str