netscaler.adc.channel_interface_binding (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Binding Resource definition for describing association between channel and interface resources

Inputs

    
id:
    description:
    - ID of the LA channel or the cluster LA channel to which you want to bind interfaces.
      Specify an LA channel in LA/x notation, where x can range from 1 to 8 or a cluster
      LA channel in CLA/x notation or  Link redundant channel in LR/x notation , where
      x can range from 1 to 4.
    type: str

nsip:
    description:
    - The ip address of the NetScaler ADC appliance where the nitro API calls will be
      made.
    - The port can be specified with the colon (:). E.g. 192.168.1.1:555.
    required: true
    type: str

ifnum:
    description:
    - Interfaces to be bound to the LA channel of a Citrix ADC or to the LA channel of
      a cluster configuration.
    - For an LA channel of a Citrix ADC, specify an interface in C/U notation (for example,
      1/3).
    - For an LA channel of a cluster configuration, specify an interface in N/C/U notation
      (for example, 2/1/3).
    - 'where C can take one of the following values:'
    - '* 0 - Indicates a management interface.'
    - '* 1 - Indicates a 1 Gbps port.'
    - '* 10 - Indicates a 10 Gbps port.'
    - U is a unique integer for representing an interface in a particular port group.
    - N is the ID of the node to which an interface belongs in a cluster configuration.
    - Use spaces to separate multiple entries.
    elements: str
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(present), the resource will be added/updated configured according to the
      module's parameters.
    - When C(absent), the resource will be deleted from the NetScaler ADC node.
    type: str

svmcmd:
    description:
    - New attribute added to identify the source of cmd, when SVM fires the nitro cmd,
      it will set the value of SVMCMD to be 1.
    type: float

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

nitro_pass:
    description:
    - The password with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

save_config:
    default: false
    description:
    - If C(true) the module will save the configuration on the NetScaler ADC node if it
      makes any changes.
    - The module will not save the configuration on the NetScaler ADC node if it made
      no changes.
    type: bool

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

Outputs

changed:
  description: Indicates if any change is made by the module
  returned: always
  sample: true
  type: bool
diff:
  description: Dictionary of before and after changes
  returned: always
  sample:
    after:
      key2: pqr
    before:
      key1: xyz
    prepared: changes done
  type: dict
diff_list:
  description: List of differences between the actual configured object and the configuration
    specified in the module
  returned: when changed
  sample:
  - 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
    PQR'
  type: list
failed:
  description: Indicates if the module failed or not
  returned: always
  sample: false
  type: bool
loglines:
  description: list of logged messages by the module
  returned: always
  sample:
  - message 1
  - message 2
  type: list