a10_aam_jwt_authorization
Synopsis
AAM JWT authorization related configuration
Parameters
Parameters |
Choices/Defaults |
Comment |
|
---|---|---|---|
state str/required |
[‘noop’, ‘present’, ‘absent’] |
State of the object to be created. |
|
ansible_host str/required |
Host for AXAPI authentication |
||
ansible_username str/required |
Username for AXAPI authentication |
||
ansible_password str/required |
Password for AXAPI authentication |
||
ansible_port int/required |
Port for AXAPI authentication |
||
a10_device_context_id int |
[‘1-8’] |
Device ID for aVCS configuration |
|
a10_partition str |
Destination/target partition for object/command |
||
name str/required |
Specify JWT authorization template name |
||
verification_cert str |
Specify the certificate to verify JWT token signature |
||
verification_jwks str |
Specify the jwks file to verify JWT token signature |
||
verification_secret str |
Specify secret for verify JWT token signature |
||
encrypted str |
Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) |
||
jwt_cache_enable bool |
Enable caching authorized JWT token and skip verification and authorization for cached tokens |
||
log_level str |
‘0’= log disable; ‘1’= only log authorzation fail (default); ‘2’= only log authorization success; ‘3’= log all; |
||
exp_claim_requried bool |
Specify the exp claim is required for JWT authorization |
||
jwt_exp_default int |
Specify the default token expiration if exp claim is not available (default 1800) |
||
jwt_forwarding bool |
Specify JWT token will not be stripped while forwarding client request |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
counters1 str |
‘all’= all; ‘jwt-request’= JWT Request; ‘jwt-authorize-success’= JWT Authorize Success; ‘jwt-authorize-failure’= JWT Authorize Failure; ‘jwt-missing-token’= JWT Missing Token; ‘jwt-missing-claim’= JWT Missing Claim; ‘jwt-token-expired’= JWT Token Expired; ‘jwt-signature-failure’= JWT Signature Failure; ‘jwt-other- error’= JWT Other Error; |
||
packet_capture_template str |
Name of the packet capture template to be bind with this object |
||
stats dict |
Field stats |
||
jwt_request str |
JWT Request |
||
jwt_authorize_success str |
JWT Authorize Success |
||
jwt_authorize_failure str |
JWT Authorize Failure |
||
jwt_missing_token str |
JWT Missing Token |
||
jwt_missing_claim str |
JWT Missing Claim |
||
jwt_token_expired str |
JWT Token Expired |
||
jwt_signature_failure str |
JWT Signature Failure |
||
jwt_other_error str |
JWT Other Error |
||
name str |
Specify JWT authorization template name |
Examples
Return Values
- modified_values (changed, dict, )
Values modified (or potential changes if using check_mode) as a result of task operation
- axapi_calls (always, list, )
Sequential list of AXAPI calls made by the task
- endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])
The AXAPI endpoint being accessed.
- http_method (, str, [‘POST’, ‘GET’])
HTTP method being used by the primary task to interact with the AXAPI endpoint.
- request_body (, complex, )
Params used to query the AXAPI
- response_body (, complex, )
Response from the AXAPI
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.
Authors
A10 Networks