netscaler.adc.csvserver_feopolicy_binding (2.5.1) — module

Binding Resource definition for describing association between csvserver and feopolicy resources

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

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 csvserver and feopolicy resources

Inputs

    
name:
    description:
    - Name of the content switching virtual server to which the content switching policy
      applies.
    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

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

invoke:
    description:
    - Invoke a policy label if this policy's rule evaluates to TRUE.
    type: bool

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

priority:
    description:
    - Priority for the policy.
    type: float

bindpoint:
    choices:
    - REQUEST
    - RESPONSE
    - ICA_REQUEST
    - OTHERTCP_REQUEST
    - MQTT_JUMBO_REQ
    description:
    - The bindpoint to which the policy is bound
    type: str

labelname:
    description:
    - Name of the label to be invoked.
    type: str

labeltype:
    choices:
    - reqvserver
    - resvserver
    - policylabel
    description:
    - Type of label to be invoked.
    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

policyname:
    description:
    - Policies bound to this vserver.
    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

targetlbvserver:
    description:
    - Name of the Load Balancing virtual server to which the content is switched, if policy
      rule is evaluated to be TRUE.
    - 'Example: bind cs vs cs1 -policyname pol1 -priority 101 -targetLBVserver lb1'
    - 'Note: Use this parameter only in case of Content Switching policy bind operations
      to a CS vserver'
    type: str

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

gotopriorityexpression:
    description:
    - Expression specifying the priority of the next policy which will get evaluated if
      the current policy rule evaluates to TRUE.
    type: str

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