netscaler.adc.nssimpleacl (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

Configuration for simple ACL resource.

Inputs

    
td:
    description:
    - Integer value that uniquely identifies the traffic domain in which you want to configure
      the entity. If you do not specify an ID, the entity becomes part of the default
      traffic domain, which has an ID of 0.
    type: float

ttl:
    description:
    - Number of seconds, in multiples of four, after which the simple ACL rule expires.
      If you do not want the simple ACL rule to expire, do not specify a TTL value.
    type: float

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

srcip:
    description:
    - IP address to match against the source IP address of an incoming IPv4 packet.
    type: str

state:
    choices:
    - present
    - absent
    - flushed
    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.
    - When C(flushed), the resource will be flushed on the NetScaler ADC node.
    type: str

aclname:
    description:
    - Name for the simple ACL rule. Must begin with an ASCII alphabetic or underscore
      (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period
      (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be
      changed after the simple ACL rule is created.
    type: str

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

destport:
    description:
    - Port number to match against the destination port number of an incoming IPv4 packet.
    - ''
    - DestPort is mandatory while setting Protocol. Omitting the port number and protocol
      creates an all-ports  and all protocols simple ACL rule, which matches any port
      and any protocol. In that case, you cannot create another simple ACL rule specifying
      a specific port and the same source IPv4 address.
    type: int

protocol:
    choices:
    - TCP
    - UDP
    description:
    - Protocol to match against the protocol of an incoming IPv4 packet. You must set
      this parameter if you have set the Destination Port parameter.
    type: str

aclaction:
    choices:
    - DENY
    description:
    - Drop incoming IPv4 packets that match the simple ACL rule.
    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

estsessions:
    description:
    - '0'
    type: bool

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