Try SpotterConfiguration for HTTP callout resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for HTTP callout resource.
name:
description:
- Name for the HTTP callout. Not case sensitive. Must begin with an ASCII letter or
underscore (_) character, and must consist only of ASCII alphanumeric or underscore
characters. Must not begin with 're' or 'xp' or be a word reserved for use as an
expression qualifier prefix (such as HTTP) or enumeration value (such as ASCII).
Must not be the name of an existing named expression, pattern set, dataset, stringmap,
or HTTP callout.
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
port:
description:
- Server port to which the HTTP callout agent is mapped. Mutually exclusive with the
Virtual Server parameter. Therefore, you cannot set the <IP Address, Port> and the
Virtual Server in the same HTTP callout.
type: int
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
scheme:
choices:
- http
- https
description:
- Type of scheme for the callout server.
type: str
comment:
description:
- Any comments to preserve information about this HTTP callout.
type: str
headers:
description:
- One or more headers to insert into the HTTP request. 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
an HTTP callout. Mutually exclusive with the full HTTP request expression.
elements: str
type: list
vserver:
description:
- Name of the load balancing, content switching, or cache redirection virtual server
(the callout agent) to which the HTTP callout is sent. The service type of the virtual
server must be HTTP. Mutually exclusive with the IP address and port parameters.
Therefore, you cannot set the <IP Address, Port> and the Virtual Server in the same
HTTP callout.
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
bodyexpr:
description:
- An advanced string expression for generating the body of the request. The expression
can contain a literal string or an expression that derives the value (for example,
client.ip.src). Mutually exclusive with -fullReqExpr.
type: str
hostexpr:
description:
- String expression to configure the Host header. Can contain a literal value (for
example, 10.101.10.11) or a derived value (for example, http.req.header("Host")).
The literal value can be an IP address or a fully qualified domain name. Mutually
exclusive with the full HTTP request expression.
type: str
ipaddress:
description:
- IP Address of the server (callout agent) to which the callout is sent. Can be an
IPv4 or IPv6 address.
- Mutually exclusive with the Virtual Server parameter. Therefore, you cannot set
the <IP Address, Port> and the Virtual Server in the same HTTP callout.
type: str
httpmethod:
choices:
- GET
- POST
description:
- Method used in the HTTP request that this callout sends. Mutually exclusive with
the full HTTP request expression.
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
parameters:
description:
- One or more query parameters to insert into the HTTP request URL (for a GET request)
or into the request body (for a POST request). Each parameter is specified as "name(expr)",
where expr is an expression that is evaluated at run time to provide the value for
the named parameter (name=value). The parameter values are URL encoded. Mutually
exclusive with the full HTTP request expression.
elements: str
type: list
resultexpr:
description:
- 'Expression that extracts the callout results from the response sent by the HTTP
callout agent. Must be a response based expression, that is, it must begin with
HTTP.RES. The operations in this expression must match the return type. For example,
if you configure a return type of TEXT, the result expression must be a text based
expression. If the return type is NUM, the result expression (resultExpr) must return
a numeric value, as in the following example: http.res.body(10000).length.'
type: str
returntype:
choices:
- BOOL
- NUM
- TEXT
description:
- 'Type of data that the target callout agent returns in response to the callout. '
- 'Available settings function as follows:'
- '* C(TEXT) - Treat the returned value as a text string. '
- '* C(NUM) - Treat the returned value as a number.'
- '* C(BOOL) - Treat the returned value as a Boolean value. '
- 'Note: You cannot change the return type after it is set.'
type: str
fullreqexpr:
description:
- Exact HTTP request, in the form of an expression, which the Citrix ADC sends to
the callout agent. If you set this parameter, you must not include HTTP method,
host expression, URL stem expression, headers, or parameters.
- The request expression is constrained by the feature for which the callout is used.
For example, an HTTP.RES expression cannot be used in a request-time policy bank
or in a TCP content switching policy bank.
- The Citrix ADC does not check the validity of this request. You must manually validate
the request.
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
urlstemexpr:
description:
- String expression for generating the URL stem. Can contain a literal string (for
example, "/mysite/index.html") or an expression that derives the value (for example,
http.req.url). Mutually exclusive with the full HTTP request expression.
type: str
cacheforsecs:
description:
- Duration, in seconds, for which the callout response is cached. The cached responses
are stored in an integrated caching content group named "calloutContentGroup". If
no duration is configured, the callout responses will not be cached unless normal
caching configuration is used to cache them. This parameter takes precedence over
any normal caching configuration that would otherwise apply to these responses.
- "\t Note that the calloutContentGroup definition may not be modified or removed\
\ nor may it be used with other cache policies."
type: float
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
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