netscaler.adc.policypatset_pattern_binding module – Binding Resource definition for describing association between policypatset and pattern resources

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.policypatset_pattern_binding.

New in netscaler.adc 2.0.0

Synopsis

  • Binding Resource definition for describing association between policypatset and pattern resources

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

builtin

list / elements=string

Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

Choices:

  • "MODIFIABLE"

  • "DELETABLE"

  • "IMMUTABLE"

  • "PARTITION_ALL"

charset

string

Character set associated with the characters in the string.

Note: UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes ‘\xNN’. For example, the UTF-8 character ‘’ can be encoded as ‘\xC3\xBC’.

Choices:

  • "ASCII"

  • "UTF_8"

comment

string

Any comments to preserve information about this patset or a pattern bound to this patset.

feature

string

The feature to be checked while applying this config

Choices:

  • "WL"

  • "WebLogging"

  • "SP"

  • "SurgeProtection"

  • "LB"

  • "LoadBalancing"

  • "CS"

  • "ContentSwitching"

  • "CR"

  • "CacheRedirection"

  • "SC"

  • "SureConnect"

  • "CMP"

  • "CMPcntl"

  • "CompressionControl"

  • "PQ"

  • "PriorityQueuing"

  • "HDOSP"

  • "HttpDoSProtection"

  • "SSLVPN"

  • "AAA"

  • "GSLB"

  • "GlobalServerLoadBalancing"

  • "SSL"

  • "SSLOffload"

  • "SSLOffloading"

  • "CF"

  • "ContentFiltering"

  • "IC"

  • "IntegratedCaching"

  • "OSPF"

  • "OSPFRouting"

  • "RIP"

  • "RIPRouting"

  • "BGP"

  • "BGPRouting"

  • "REWRITE"

  • "IPv6PT"

  • "IPv6protocoltranslation"

  • "AppFw"

  • "ApplicationFirewall"

  • "RESPONDER"

  • "push"

  • "NSPush"

  • "NetScalerPush"

  • "AppFlow"

  • "CloudBridge"

  • "ISIS"

  • "ISISRouting"

  • "CH"

  • "CallHome"

  • "AppQoE"

  • "ContentAccelerator"

  • "SYSTEM"

  • "RISE"

  • "FEO"

  • "LSN"

  • "LargeScaleNAT"

  • "RDPProxy"

  • "Rep"

  • "Reputation"

  • "URLFiltering"

  • "VideoOptimization"

  • "ForwardProxy"

  • "SSLInterception"

  • "AdaptiveTCP"

  • "CQA"

  • "CI"

  • "ContentInspection"

  • "Bot"

  • "APIGateway"

index

float

The index of the string associated with the patset.

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

name

string

Name of the pattern set to which to bind the string.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

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.

save_config

boolean

If 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.

Choices:

  • false ← (default)

  • true

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

string

string

String of characters that constitutes a pattern. For more information about the characters that can be used, refer to the character set parameter.

Note: Minimum length for pattern sets used in rewrite actions of type REPLACE_ALL, DELETE_ALL, INSERT_AFTER_ALL, and INSERT_BEFORE_ALL, is three characters.

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

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"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)