New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_context
(added in 2.5) |
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
|
|
api_version |
Default: 16.4.4
|
Avi API version of to use for Avi API and objects.
|
avi_api_patch_op
(added in 2.5) |
|
Patch operation to use when using avi_api_update_method as patch.
|
avi_api_update_method
(added in 2.5) |
|
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
|
avi_credentials
(added in 2.5) |
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
|
controller |
Default: |
IP address or hostname of the controller. The default value is the environment variable
AVI_CONTROLLER . |
password |
Default: |
Password of Avi user in Avi controller. The default value is the environment variable
AVI_PASSWORD . |
se_agent_properties |
Seagentproperties settings for seproperties.
|
|
se_bootup_properties |
Sebootupproperties settings for seproperties.
|
|
se_runtime_properties |
Seruntimeproperties settings for seproperties.
|
|
state |
|
The state that should be applied on the entity.
|
tenant |
Default: admin
|
Name of tenant used for all Avi API calls and context of object.
|
tenant_uuid |
Default: |
UUID of tenant used for all Avi API calls and context of object.
|
url |
Avi controller URL of the object.
|
|
username |
Default: |
Username used for accessing Avi controller. The default value is the environment variable
AVI_USERNAME . |
uuid |
Unique object identifier of the object.
Default value when not specified in API or module is interpreted by Avi Controller as default.
|
Note
- name: Example to create SeProperties object
avi_seproperties:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_seproperties
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
obj
dict
|
success, changed |
SeProperties (api/seproperties) object
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.