ibm.isam.isam (1.1.1) — connection

Install collection

Install with ansible-galaxy collection install ibm.isam:==1.1.1

Add to requirements.yml

  collections:
    - name: ibm.isam
      version: 1.1.1

Description

This connection plugin provides a connection to IBM ISAM devices via the C(ibmsecurity) python library.

Inputs

    
host:
    default: inventory_hostname
    description:
    - Specifies the remote device FQDN or IP address of the IBM ISAM Appliance to establish
      a connection to.
    type: str
    vars:
    - name: inventory_hostname
    - name: ansible_host
    - name: remote_addr

port:
    description:
    - Specifies the port on the LMI Port that the IBM ISAM Appliance listens on.
    env:
    - name: ANSIBLE_ISAM_PORT
    ini:
    - key: remote_port
      section: defaults
    type: int
    vars:
    - name: ansible_isam_port

user:
    description:
    - The username used to authenticate to the remote device when the API connection is
      first established.  If the remote_user is not specified, the connection will use
      the username of the logged in user.
    - Can be provided to the ansible CLI via the C(--user) or C(-u) options.
    env:
    - name: ANSIBLE_ISAM_USER
    ini:
    - key: remote_user
      section: defaults
    type: str
    vars:
    - name: ansible_isam_user
    - name: ansible_isam_username

password:
    description:
    - Password used to authenticate to the IBM ISAM Appliance.
    type: str
    vars:
    - name: ansible_password
    - name: ansible_isam_pass
    - name: ansible_isam_password

persistent_log_messages:
    default: false
    description:
    - This flag will enable logging the command executed and response received from target
      device in the ansible log file. For this option to work 'log_path' ansible configuration
      option is required to be set to a file path with write access.
    - Be sure to fully understand the security implications of enabling this option as
      it could create a security vulnerability by logging sensitive information in log
      file.
    env:
    - name: ANSIBLE_PERSISTENT_LOG_MESSAGES
    ini:
    - key: log_messages
      section: persistent_connection
    type: boolean
    vars:
    - name: ansible_persistent_log_messages

persistent_command_timeout:
    default: 30
    description:
    - Configures, in seconds, the amount of time to wait for a command to return from
      the remote device.  If this timer is exceeded before the command returns, the connection
      plugin will raise an exception and close.
    env:
    - name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
    ini:
    - key: command_timeout
      section: persistent_connection
    type: int
    vars:
    - name: ansible_command_timeout

persistent_connect_timeout:
    default: 30
    description:
    - Configures, in seconds, the amount of time to wait when trying to initially establish
      a persistent connection.  If this value expires before the connection to the remote
      device is completed, the connection will fail.
    env:
    - name: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
    ini:
    - key: connect_timeout
      section: persistent_connection
    type: int
    vars:
    - name: ansible_connect_timeout