netscaler.adc.responderaction (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 responder action resource.

Inputs

    
name:
    description:
    - Name for the responder action. Must begin with a letter, number, or the underscore
      character (_), and must contain only letters, numbers, and the hyphen (-), period
      (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
      Can be changed after the responder policy is added.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my responder action" or 'my responder action').
    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

type:
    choices:
    - noop
    - respondwith
    - redirect
    - respondwithhtmlpage
    - sqlresponse_ok
    - sqlresponse_error
    description:
    - 'Type of responder action. Available settings function as follows:'
    - '* C(respondwith) <target> - Respond to the request with the expression specified
      as the target.'
    - '* C(respondwithhtmlpage) - Respond to the request with the uploaded HTML page object
      specified as the target.'
    - '* C(redirect) - Redirect the request to the URL specified as the target.'
    - '* C(sqlresponse_ok) - Send an SQL OK response.'
    - '* C(sqlresponse_error) - Send an SQL ERROR response.'
    type: str

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

target:
    description:
    - Expression specifying what to respond with. Typically a URL for redirect policies
      or a default-syntax expression.  In addition to Citrix ADC default-syntax expressions
      that refer to information in the request, a stringbuilder expression can contain
      text and HTML, and simple escape codes that define new lines and paragraphs. Enclose
      each stringbuilder expression element (either a Citrix ADC default-syntax expression
      or a string) in double quotation marks. Use the plus (+) character to join the elements.
    - ''
    - 'Examples:'
    - '1) Respondwith expression that sends an HTTP 1.1 200 OK response:'
    - '"HTTP/1.1 200 OK\r\n\r\n"'
    - ''
    - 2) Redirect expression that redirects user to the specified web host and appends
      the request URL to the redirect.
    - '"http://backupsite2.com" + HTTP.REQ.URL'
    - ''
    - '3) Respondwith expression that sends an HTTP 1.1 404 Not Found response with the
      request URL included in the response:'
    - '"HTTP/1.1 404 Not Found\r\n\r\n"+ "HTTP.REQ.URL.HTTP_URL_SAFE" + "does not exist
      on the web server."'
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - Enclose the entire expression in single quotation marks. (Citrix ADC expression
      elements should be included inside the single quotation marks for the entire expression,
      but do not need to be enclosed in double quotation marks.)
    type: str

comment:
    description:
    - Comment. Any type of information about this responder action.
    type: str

headers:
    description:
    - One or more headers to insert into the HTTP response. Each header is specified as
      "name(expr)", where expr is an expression that is evaluated at runtime to provide
      the value for the named header. You can configure a maximum of eight headers for
      a responder action.
    elements: str
    type: list

newname:
    description:
    - New name for the responder action.
    - Must begin with a letter, number, or the underscore character (_), and must contain
      only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@),
      equals (=), colon (:), and underscore characters.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my responder action" or my responder action').
    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

htmlpage:
    description:
    - For respondwithhtmlpage policies, name of the HTML page object to use as the response.
      You must first import the page object.
    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

reasonphrase:
    description:
    - 'Expression specifying the reason phrase of the HTTP response. The reason phrase
      may be a string literal with quotes or a PI expression. For example: "Invalid URL:
      " + HTTP.REQ.URL'
    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

bypasssafetycheck:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Bypass the safety check, allowing potentially unsafe expressions. An unsafe expression
      in a response is one that contains references to request elements that might not
      be present in all requests. If a response refers to a missing request element, an
      empty string is used instead.
    type: str

responsestatuscode:
    description:
    - HTTP response status code, for example 200, 302, 404, etc. The default value for
      the redirect action type is 302 and for respondwithhtmlpage is 200
    type: float

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