community.cip.logix (1.0.1) — connection

Install collection

Install with ansible-galaxy collection install community.cip:==1.0.1

Add to requirements.yml

  collections:
    - name: community.cip
      version: 1.0.1

Description

This connection plugin provides a connection to Rockwell Allen-Bradley ControlLogix via the C(pycomm3) python library.

Inputs

    
host:
    default: inventory_hostname
    description:
    - Specifies the remote device IP address of the ControlLogix to establish a connection
      to.
    - Notation can be IP Adress alone, "192.168.100.100" and slot 0 will be assumed. Alternatively
      the slot can be provided as IPAddress/SlotNumber, "192.168.100.100/3".
    type: str
    vars:
    - name: ansible_host

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