netscaler.adc.appfwprofile_jsondosurl_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 appfwprofile and jsondosurl resources

Inputs

    
name:
    description:
    - Name of the profile to which to bind an exemption or rule.
    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

comment:
    description:
    - Any comments about the purpose of profile, or other useful information about the
      profile.
    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

ruletype:
    choices:
    - ALLOW
    - DENY
    description:
    - Specifies rule type of binding
    type: str

alertonly:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Send SNMP alert?
    type: str

jsondosurl:
    description:
    - The URL on which we need to enforce the specified JSON denial-of-service (JSONDoS)
      attack protections.
    - 'An JSON DoS configuration consists of the following items:'
    - '* URL. PCRE-format regular expression for the URL.'
    - '* Maximum-document-length-check toggle.  ON to enable this check, OFF to disable
      it.'
    - '* Maximum document length. Positive integer representing the maximum length of
      the JSON document.'
    - '* Maximum-container-depth-check toggle. ON to enable, OFF to disable.'
    - ' * Maximum container depth. Positive integer representing the maximum container
      depth of the JSON document.'
    - '* Maximum-object-key-count-check toggle. ON to enable, OFF to disable.'
    - '* Maximum object key count. Positive integer representing the maximum allowed number
      of keys in any of the  JSON object.'
    - '* Maximum-object-key-length-check toggle. ON to enable, OFF to disable.'
    - '* Maximum object key length. Positive integer representing the maximum allowed
      length of key in any of the  JSON object.'
    - '* Maximum-array-value-count-check toggle. ON to enable, OFF to disable.'
    - '* Maximum array value count. Positive integer representing the maximum allowed
      number of values in any of the JSON array.'
    - '* Maximum-string-length-check toggle. ON to enable, OFF to disable.'
    - '* Maximum string length. Positive integer representing the maximum length of string
      in JSON.'
    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

resourceid:
    description:
    - A "id" that identifies the rule.
    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

isautodeployed:
    choices:
    - AUTODEPLOYED
    - NOTAUTODEPLOYED
    description:
    - Is the rule auto deployed by dynamic profile ?
    type: str

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

jsonmaxarraylength:
    description:
    - Maximum array length in the any of JSON object. This check protects against arrays
      having large lengths.
    type: float

jsonmaxstringlength:
    description:
    - Maximum string length in the JSON. This check protects against strings that have
      large length.
    type: float

jsonmaxcontainerdepth:
    description:
    - Maximum allowed nesting depth  of JSON document. JSON allows one to nest the containers
      (object and array) in any order to any depth. This check protects against documents
      that have excessive depth of hierarchy.
    type: float

jsonmaxdocumentlength:
    description:
    - Maximum document length of JSON document, in bytes.
    type: float

jsonmaxobjectkeycount:
    description:
    - Maximum key count in the any of JSON object. This check protects against objects
      that have large number of keys.
    type: float

jsonmaxobjectkeylength:
    description:
    - Maximum key length in the any of JSON object. This check protects against objects
      that have large keys.
    type: float

jsonmaxarraylengthcheck:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - State if JSON Max array value count check is C(ON) or C(OFF).
    type: str

jsonmaxstringlengthcheck:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - State if JSON Max string value count check is C(ON) or C(OFF).
    type: str

jsonmaxcontainerdepthcheck:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - State if JSON Max depth check is C(ON) or C(OFF).
    type: str

jsonmaxdocumentlengthcheck:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - State if JSON Max document length check is C(ON) or C(OFF).
    type: str

jsonmaxobjectkeycountcheck:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - State if JSON Max object key count check is C(ON) or C(OFF).
    type: str

jsonmaxobjectkeylengthcheck:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - State if JSON Max object key length check is C(ON) or C(OFF).
    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