Updated the documentation of modules to match argspec including the type setting for bool parameters (#36821) (#36860)
(cherry picked from commit 60e39b9718
)
This commit is contained in:
parent
bfbea05d26
commit
f5684acee5
37 changed files with 176 additions and 41 deletions
|
@ -49,6 +49,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Trigger notification to autoscale manager.
|
- Trigger notification to autoscale manager.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- User defined description for the object.
|
- User defined description for the object.
|
||||||
|
@ -61,6 +62,7 @@ options:
|
||||||
- Generate alert only to external destinations.
|
- Generate alert only to external destinations.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
required: true
|
required: true
|
||||||
|
type: bool
|
||||||
level:
|
level:
|
||||||
description:
|
description:
|
||||||
- When an alert is generated, mark its priority via the alert level.
|
- When an alert is generated, mark its priority via the alert level.
|
||||||
|
|
|
@ -52,6 +52,7 @@ options:
|
||||||
autoscale_alert:
|
autoscale_alert:
|
||||||
description:
|
description:
|
||||||
- This alert config applies to auto scale alerts.
|
- This alert config applies to auto scale alerts.
|
||||||
|
type: bool
|
||||||
category:
|
category:
|
||||||
description:
|
description:
|
||||||
- Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time
|
- Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time
|
||||||
|
@ -66,6 +67,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Enable or disable this alert config from generating new alerts.
|
- Enable or disable this alert config from generating new alerts.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
expiry_time:
|
expiry_time:
|
||||||
description:
|
description:
|
||||||
- An alert is expired and deleted after the expiry time has elapsed.
|
- An alert is expired and deleted after the expiry time has elapsed.
|
||||||
|
@ -88,35 +90,35 @@ options:
|
||||||
- SSLPROFILE, SSLKEYANDCERTIFICATE, NETWORKSECURITYPOLICY, APPLICATIONPERSISTENCEPROFILE, ANALYTICSPROFILE, VSDATASCRIPTSET, TENANT, PKIPROFILE,
|
- SSLPROFILE, SSLKEYANDCERTIFICATE, NETWORKSECURITYPOLICY, APPLICATIONPERSISTENCEPROFILE, ANALYTICSPROFILE, VSDATASCRIPTSET, TENANT, PKIPROFILE,
|
||||||
- AUTHPROFILE, CLOUD, SERVERAUTOSCALEPOLICY, AUTOSCALELAUNCHCONFIG, MICROSERVICEGROUP, IPAMPROFILE, HARDWARESECURITYMODULEGROUP, POOLGROUP,
|
- AUTHPROFILE, CLOUD, SERVERAUTOSCALEPOLICY, AUTOSCALELAUNCHCONFIG, MICROSERVICEGROUP, IPAMPROFILE, HARDWARESECURITYMODULEGROUP, POOLGROUP,
|
||||||
- PRIORITYLABELS, POOLGROUPDEPLOYMENTPOLICY, GSLBSERVICE, GSLBSERVICERUNTIME, SCHEDULER, GSLBGEODBPROFILE, GSLBAPPLICATIONPERSISTENCEPROFILE,
|
- PRIORITYLABELS, POOLGROUPDEPLOYMENTPOLICY, GSLBSERVICE, GSLBSERVICERUNTIME, SCHEDULER, GSLBGEODBPROFILE, GSLBAPPLICATIONPERSISTENCEPROFILE,
|
||||||
- TRAFFICCLONEPROFILE, VSVIP, WAFPOLICY, WAFPROFILE, ERRORPAGEPROFILE, ERRORPAGEBODY, SERVICEENGINE, DEBUGSERVICEENGINE, DEBUGCONTROLLER,
|
- TRAFFICCLONEPROFILE, VSVIP, WAFPOLICY, WAFPROFILE, ERRORPAGEPROFILE, ERRORPAGEBODY, L4POLICYSET, SERVICEENGINE, DEBUGSERVICEENGINE,
|
||||||
- DEBUGVIRTUALSERVICE, SERVICEENGINEGROUP, SEPROPERTIES, NETWORK, CONTROLLERNODE, CONTROLLERPROPERTIES, SYSTEMCONFIGURATION, VRFCONTEXT, USER,
|
- DEBUGCONTROLLER, DEBUGVIRTUALSERVICE, SERVICEENGINEGROUP, SEPROPERTIES, NETWORK, CONTROLLERNODE, CONTROLLERPROPERTIES, SYSTEMCONFIGURATION,
|
||||||
- ALERTCONFIG, ALERTSYSLOGCONFIG, ALERTEMAILCONFIG, ALERTTYPECONFIG, APPLICATION, ROLE, CLOUDPROPERTIES, SNMPTRAPPROFILE, ACTIONGROUPPROFILE,
|
- VRFCONTEXT, USER, ALERTCONFIG, ALERTSYSLOGCONFIG, ALERTEMAILCONFIG, ALERTTYPECONFIG, APPLICATION, ROLE, CLOUDPROPERTIES, SNMPTRAPPROFILE,
|
||||||
- MICROSERVICE, ALERTPARAMS, ACTIONGROUPCONFIG, CLOUDCONNECTORUSER, GSLB, GSLBDNSUPDATE, GSLBSITEOPS, GLBMGRWARMSTART, IPAMDNSRECORD,
|
- ACTIONGROUPPROFILE, MICROSERVICE, ALERTPARAMS, ACTIONGROUPCONFIG, CLOUDCONNECTORUSER, GSLB, GSLBDNSUPDATE, GSLBSITEOPS, GLBMGRWARMSTART,
|
||||||
- GSLBDNSGSSTATUS, GSLBDNSGEOFILEOPS, GSLBDNSGEOUPDATE, GSLBDNSGEOCLUSTEROPS, GSLBDNSCLEANUP, GSLBSITEOPSRESYNC, TCPSTATRUNTIME, UDPSTATRUNTIME,
|
- IPAMDNSRECORD, GSLBDNSGSSTATUS, GSLBDNSGEOFILEOPS, GSLBDNSGEOUPDATE, GSLBDNSGEOCLUSTEROPS, GSLBDNSCLEANUP, GSLBSITEOPSRESYNC, TCPSTATRUNTIME,
|
||||||
- IPSTATRUNTIME, ARPSTATRUNTIME, MBSTATRUNTIME, IPSTKQSTATSRUNTIME, MALLOCSTATRUNTIME, SHMALLOCSTATRUNTIME, CPUUSAGERUNTIME, L7GLOBALSTATSRUNTIME,
|
- UDPSTATRUNTIME, IPSTATRUNTIME, ARPSTATRUNTIME, MBSTATRUNTIME, IPSTKQSTATSRUNTIME, MALLOCSTATRUNTIME, SHMALLOCSTATRUNTIME, CPUUSAGERUNTIME,
|
||||||
- L7VIRTUALSERVICESTATSRUNTIME, SEAGENTVNICDBRUNTIME, SEAGENTGRAPHDBRUNTIME, SEAGENTSTATERUNTIME, INTERFACERUNTIME, ARPTABLERUNTIME,
|
- L7GLOBALSTATSRUNTIME, L7VIRTUALSERVICESTATSRUNTIME, SEAGENTVNICDBRUNTIME, SEAGENTGRAPHDBRUNTIME, SEAGENTSTATERUNTIME, INTERFACERUNTIME,
|
||||||
- DISPATCHERSTATRUNTIME, DISPATCHERSTATCLEARRUNTIME, DISPATCHERTABLEDUMPRUNTIME, DISPATCHERREMOTETIMERLISTDUMPRUNTIME, METRICSAGENTMESSAGE,
|
- ARPTABLERUNTIME, DISPATCHERSTATRUNTIME, DISPATCHERSTATCLEARRUNTIME, DISPATCHERTABLEDUMPRUNTIME, DISPATCHERREMOTETIMERLISTDUMPRUNTIME,
|
||||||
- HEALTHMONITORSTATRUNTIME, METRICSENTITYRUNTIME, PERSISTENCEINTERNAL, HTTPPOLICYSETINTERNAL, DNSPOLICYINTERNAL, CONNECTIONDUMPRUNTIME,
|
- METRICSAGENTMESSAGE, HEALTHMONITORSTATRUNTIME, METRICSENTITYRUNTIME, PERSISTENCEINTERNAL, HTTPPOLICYSETINTERNAL, DNSPOLICYINTERNAL,
|
||||||
- SHAREDDBSTATS, SHAREDDBSTATSCLEAR, ICMPSTATRUNTIME, ROUTETABLERUNTIME, VIRTUALMACHINE, POOLSERVER, SEVSLIST, MEMINFORUNTIME, RTERINGSTATRUNTIME,
|
- CONNECTIONDUMPRUNTIME, SHAREDDBSTATS, SHAREDDBSTATSCLEAR, ICMPSTATRUNTIME, ROUTETABLERUNTIME, VIRTUALMACHINE, POOLSERVER, SEVSLIST,
|
||||||
- ALGOSTATRUNTIME, HEALTHMONITORRUNTIME, CPUSTATRUNTIME, SEVM, HOST, PORTGROUP, CLUSTER, DATACENTER, VCENTER, HTTPPOLICYSETSTATS, DNSPOLICYSTATS,
|
- MEMINFORUNTIME, RTERINGSTATRUNTIME, ALGOSTATRUNTIME, HEALTHMONITORRUNTIME, CPUSTATRUNTIME, SEVM, HOST, PORTGROUP, CLUSTER, DATACENTER, VCENTER,
|
||||||
- METRICSSESTATS, RATELIMITERSTATRUNTIME, NETWORKSECURITYPOLICYSTATS, TCPCONNRUNTIME, POOLSTATS, CONNPOOLINTERNAL, CONNPOOLSTATS, VSHASHSHOWRUNTIME,
|
- HTTPPOLICYSETSTATS, DNSPOLICYSTATS, METRICSSESTATS, RATELIMITERSTATRUNTIME, NETWORKSECURITYPOLICYSTATS, TCPCONNRUNTIME, POOLSTATS,
|
||||||
- SELOGSTATSRUNTIME, NETWORKSECURITYPOLICYDETAIL, LICENSERUNTIME, SERVERRUNTIME, METRICSRUNTIMESUMMARY, METRICSRUNTIMEDETAIL,
|
- CONNPOOLINTERNAL, CONNPOOLSTATS, VSHASHSHOWRUNTIME, SELOGSTATSRUNTIME, NETWORKSECURITYPOLICYDETAIL, LICENSERUNTIME, SERVERRUNTIME,
|
||||||
- DISPATCHERSEHMPROBETEMPDISABLERUNTIME, POOLDEBUG, VSLOGMGRMAP, SERUMINSERTIONSTATS, HTTPCACHE, HTTPCACHESTATS, SEDOSSTATRUNTIME, VSDOSSTATRUNTIME,
|
- METRICSRUNTIMESUMMARY, METRICSRUNTIMEDETAIL, DISPATCHERSEHMPROBETEMPDISABLERUNTIME, POOLDEBUG, VSLOGMGRMAP, SERUMINSERTIONSTATS, HTTPCACHE,
|
||||||
- SERVERUPDATEREQ, VSSCALEOUTLIST, SEMEMDISTRUNTIME, TCPCONNRUNTIMEDETAIL, SEUPGRADESTATUS, SEUPGRADEPREVIEW, SEFAULTINJECTEXHAUSTM,
|
- HTTPCACHESTATS, SEDOSSTATRUNTIME, VSDOSSTATRUNTIME, SERVERUPDATEREQ, VSSCALEOUTLIST, SEMEMDISTRUNTIME, TCPCONNRUNTIMEDETAIL, SEUPGRADESTATUS,
|
||||||
- SEFAULTINJECTEXHAUSTMCL, SEFAULTINJECTEXHAUSTMCLSMALL, SEFAULTINJECTEXHAUSTCONN, SEHEADLESSONLINEREQ, SEUPGRADE, SEUPGRADESTATUSDETAIL,
|
- SEUPGRADEPREVIEW, SEFAULTINJECTEXHAUSTM, SEFAULTINJECTEXHAUSTMCL, SEFAULTINJECTEXHAUSTMCLSMALL, SEFAULTINJECTEXHAUSTCONN, SEHEADLESSONLINEREQ,
|
||||||
- SERESERVEDVS, SERESERVEDVSCLEAR, VSCANDIDATESEHOSTLIST, SEGROUPUPGRADE, REBALANCE, SEGROUPREBALANCE, SEAUTHSTATSRUNTIME, AUTOSCALESTATE,
|
- SEUPGRADE, SEUPGRADESTATUSDETAIL, SERESERVEDVS, SERESERVEDVSCLEAR, VSCANDIDATESEHOSTLIST, SEGROUPUPGRADE, REBALANCE, SEGROUPREBALANCE,
|
||||||
- VIRTUALSERVICEAUTHSTATS, NETWORKSECURITYPOLICYDOS, KEYVALINTERNAL, KEYVALSUMMARYINTERNAL, SERVERSTATEUPDATEINFO, CLTRACKINTERNAL,
|
- SEAUTHSTATSRUNTIME, AUTOSCALESTATE, VIRTUALSERVICEAUTHSTATS, NETWORKSECURITYPOLICYDOS, KEYVALINTERNAL, KEYVALSUMMARYINTERNAL,
|
||||||
- CLTRACKSUMMARYINTERNAL, MICROSERVICERUNTIME, SEMICROSERVICE, VIRTUALSERVICEANALYSIS, CLIENTINTERNAL, CLIENTSUMMARYINTERNAL,
|
- SERVERSTATEUPDATEINFO, CLTRACKINTERNAL, CLTRACKSUMMARYINTERNAL, MICROSERVICERUNTIME, SEMICROSERVICE, VIRTUALSERVICEANALYSIS, CLIENTINTERNAL,
|
||||||
- MICROSERVICEGROUPRUNTIME, BGPRUNTIME, REQUESTQUEUERUNTIME, MIGRATEALL, MIGRATEALLSTATUSSUMMARY, MIGRATEALLSTATUSDETAIL, INTERFACESUMMARYRUNTIME,
|
- CLIENTSUMMARYINTERNAL, MICROSERVICEGROUPRUNTIME, BGPRUNTIME, REQUESTQUEUERUNTIME, MIGRATEALL, MIGRATEALLSTATUSSUMMARY, MIGRATEALLSTATUSDETAIL,
|
||||||
- INTERFACELACPRUNTIME, DNSTABLE, GSLBSERVICEDETAIL, GSLBSERVICEINTERNAL, GSLBSERVICEHMONSTAT, SETROLESREQUEST, TRAFFICCLONERUNTIME,
|
- INTERFACESUMMARYRUNTIME, INTERFACELACPRUNTIME, DNSTABLE, GSLBSERVICEDETAIL, GSLBSERVICEINTERNAL, GSLBSERVICEHMONSTAT, SETROLESREQUEST,
|
||||||
- GEOLOCATIONINFO, SEVSHBSTATRUNTIME, GEODBINTERNAL, GSLBSITEINTERNAL, WAFSTATS, USERDEFINEDDATASCRIPTCOUNTERS, LLDPRUNTIME, VSESSHARINGPOOL,
|
- TRAFFICCLONERUNTIME, GEOLOCATIONINFO, SEVSHBSTATRUNTIME, GEODBINTERNAL, GSLBSITEINTERNAL, WAFSTATS, USERDEFINEDDATASCRIPTCOUNTERS, LLDPRUNTIME,
|
||||||
- SEVSSPLACEMENT, SERESOURCEPROTO, SECONSUMERPROTO, SECREATEPENDINGPROTO, PLACEMENTSTATS, SEVIPPROTO, RMVRFPROTO, VCENTERMAP, VIMGRVCENTERRUNTIME,
|
- VSESSHARINGPOOL, SEVSSPLACEMENT, L4POLICYSETSTATS, L4POLICYSETINTERNAL, SERESOURCEPROTO, SECONSUMERPROTO, SECREATEPENDINGPROTO, PLACEMENTSTATS,
|
||||||
- INTERESTEDVMS, INTERESTEDHOSTS, VCENTERSUPPORTEDCOUNTERS, ENTITYCOUNTERS, TRANSACTIONSTATS, SEVMCREATEPROGRESS, PLACEMENTSTATUS, VISUBFOLDERS,
|
- SEVIPPROTO, RMVRFPROTO, VCENTERMAP, VIMGRVCENTERRUNTIME, INTERESTEDVMS, INTERESTEDHOSTS, VCENTERSUPPORTEDCOUNTERS, ENTITYCOUNTERS,
|
||||||
- VIDATASTORE, VIHOSTRESOURCES, CLOUDCONNECTOR, VINETWORKSUBNETVMS, VIDATASTORECONTENTS, VIMGRVCENTERCLOUDRUNTIME, VIVCENTERPORTGROUPS,
|
- TRANSACTIONSTATS, SEVMCREATEPROGRESS, PLACEMENTSTATUS, VISUBFOLDERS, VIDATASTORE, VIHOSTRESOURCES, CLOUDCONNECTOR, VINETWORKSUBNETVMS,
|
||||||
- VIVCENTERDATACENTERS, VIMGRHOSTRUNTIME, PLACEMENTGLOBALS, APICCONFIGURATION, CIFTABLE, APICTRANSACTION, VIRTUALSERVICESTATEDBCACHESUMMARY,
|
- VIDATASTORECONTENTS, VIMGRVCENTERCLOUDRUNTIME, VIVCENTERPORTGROUPS, VIVCENTERDATACENTERS, VIMGRHOSTRUNTIME, PLACEMENTGLOBALS, APICCONFIGURATION,
|
||||||
- POOLSTATEDBCACHESUMMARY, SERVERSTATEDBCACHESUMMARY, APICAGENTINTERNAL, APICTRANSACTIONFLAP, APICGRAPHINSTANCES, APICEPGS, APICEPGEPS,
|
- CIFTABLE, APICTRANSACTION, VIRTUALSERVICESTATEDBCACHESUMMARY, POOLSTATEDBCACHESUMMARY, SERVERSTATEDBCACHESUMMARY, APICAGENTINTERNAL,
|
||||||
- APICDEVICEPKGVER, APICTENANTS, APICVMMDOMAINS, NSXCONFIGURATION, NSXSGTABLE, NSXAGENTINTERNAL, NSXSGINFO, NSXSGIPS, NSXAGENTINTERNALCLI,
|
- APICTRANSACTIONFLAP, APICGRAPHINSTANCES, APICEPGS, APICEPGEPS, APICDEVICEPKGVER, APICTENANTS, APICVMMDOMAINS, NSXCONFIGURATION, NSXSGTABLE,
|
||||||
- MAXOBJECTS.
|
- NSXAGENTINTERNAL, NSXSGINFO, NSXSGIPS, NSXAGENTINTERNALCLI, MAXOBJECTS.
|
||||||
recommendation:
|
recommendation:
|
||||||
description:
|
description:
|
||||||
- Recommendation of alertconfig.
|
- Recommendation of alertconfig.
|
||||||
|
|
|
@ -171,25 +171,30 @@ options:
|
||||||
description:
|
description:
|
||||||
- Disable node (service engine) level analytics forvs metrics.
|
- Disable node (service engine) level analytics forvs metrics.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
disable_server_analytics:
|
disable_server_analytics:
|
||||||
description:
|
description:
|
||||||
- Disable analytics on backend servers.
|
- Disable analytics on backend servers.
|
||||||
- This may be desired in container environment when there are large number of ephemeral servers.
|
- This may be desired in container environment when there are large number of ephemeral servers.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_client_close_before_request_as_error:
|
exclude_client_close_before_request_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude client closed connection before an http request could be completed from being classified as an error.
|
- Exclude client closed connection before an http request could be completed from being classified as an error.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_dns_policy_drop_as_significant:
|
exclude_dns_policy_drop_as_significant:
|
||||||
description:
|
description:
|
||||||
- Exclude dns policy drops from the list of errors.
|
- Exclude dns policy drops from the list of errors.
|
||||||
- Field introduced in 17.2.2.
|
- Field introduced in 17.2.2.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
exclude_gs_down_as_error:
|
exclude_gs_down_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude queries to gslb services that are operationally down from the list of errors.
|
- Exclude queries to gslb services that are operationally down from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_http_error_codes:
|
exclude_http_error_codes:
|
||||||
description:
|
description:
|
||||||
- List of http status codes to be excluded from being classified as an error.
|
- List of http status codes to be excluded from being classified as an error.
|
||||||
|
@ -198,43 +203,53 @@ options:
|
||||||
description:
|
description:
|
||||||
- Exclude dns queries to domains outside the domains configured in the dns application profile from the list of errors.
|
- Exclude dns queries to domains outside the domains configured in the dns application profile from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_invalid_dns_query_as_error:
|
exclude_invalid_dns_query_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude invalid dns queries from the list of errors.
|
- Exclude invalid dns queries from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_no_dns_record_as_error:
|
exclude_no_dns_record_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude queries to domains that did not have configured services/records from the list of errors.
|
- Exclude queries to domains that did not have configured services/records from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_no_valid_gs_member_as_error:
|
exclude_no_valid_gs_member_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude queries to gslb services that have no available members from the list of errors.
|
- Exclude queries to gslb services that have no available members from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_persistence_change_as_error:
|
exclude_persistence_change_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude persistence server changed while load balancing' from the list of errors.
|
- Exclude persistence server changed while load balancing' from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_server_dns_error_as_error:
|
exclude_server_dns_error_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude server dns error response from the list of errors.
|
- Exclude server dns error response from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_server_tcp_reset_as_error:
|
exclude_server_tcp_reset_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude server tcp reset from errors.
|
- Exclude server tcp reset from errors.
|
||||||
- It is common for applications like ms exchange.
|
- It is common for applications like ms exchange.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_syn_retransmit_as_error:
|
exclude_syn_retransmit_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude 'server unanswered syns' from the list of errors.
|
- Exclude 'server unanswered syns' from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_tcp_reset_as_error:
|
exclude_tcp_reset_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude tcp resets by client from the list of potential errors.
|
- Exclude tcp resets by client from the list of potential errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
exclude_unsupported_dns_query_as_error:
|
exclude_unsupported_dns_query_as_error:
|
||||||
description:
|
description:
|
||||||
- Exclude unsupported dns queries from the list of errors.
|
- Exclude unsupported dns queries from the list of errors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
hs_event_throttle_window:
|
hs_event_throttle_window:
|
||||||
description:
|
description:
|
||||||
- Time window (in secs) within which only unique health change events should occur.
|
- Time window (in secs) within which only unique health change events should occur.
|
||||||
|
|
|
@ -45,6 +45,7 @@ options:
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
- Timeout (in seconds) for Avi API calls.
|
- Timeout (in seconds) for Avi API calls.
|
||||||
|
default: 60
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- avi
|
- avi
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -65,6 +65,7 @@ options:
|
||||||
- Field introduced in 17.1.3.
|
- Field introduced in 17.1.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- A user-friendly name for the persistence profile.
|
- A user-friendly name for the persistence profile.
|
||||||
|
|
|
@ -63,6 +63,7 @@ options:
|
||||||
- Specifies if client ip needs to be preserved for backend connection.
|
- Specifies if client ip needs to be preserved for backend connection.
|
||||||
- Not compatible with connection multiplexing.
|
- Not compatible with connection multiplexing.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
tcp_app_profile:
|
tcp_app_profile:
|
||||||
description:
|
description:
|
||||||
- Specifies the tcp application proxy profile parameters.
|
- Specifies the tcp application proxy profile parameters.
|
||||||
|
|
|
@ -66,6 +66,7 @@ options:
|
||||||
save_local:
|
save_local:
|
||||||
description:
|
description:
|
||||||
- Local backup.
|
- Local backup.
|
||||||
|
type: bool
|
||||||
ssh_user_ref:
|
ssh_user_ref:
|
||||||
description:
|
description:
|
||||||
- Access credentials for remote destination.
|
- Access credentials for remote destination.
|
||||||
|
@ -76,6 +77,7 @@ options:
|
||||||
upload_to_remote_host:
|
upload_to_remote_host:
|
||||||
description:
|
description:
|
||||||
- Remote backup.
|
- Remote backup.
|
||||||
|
type: bool
|
||||||
url:
|
url:
|
||||||
description:
|
description:
|
||||||
- Avi controller URL of the object.
|
- Avi controller URL of the object.
|
||||||
|
|
|
@ -49,6 +49,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set apic_mode.
|
- Boolean flag to set apic_mode.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
aws_configuration:
|
aws_configuration:
|
||||||
description:
|
description:
|
||||||
- Awsconfiguration settings for cloud.
|
- Awsconfiguration settings for cloud.
|
||||||
|
@ -68,6 +69,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Select the ip address management scheme.
|
- Select the ip address management scheme.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
dns_provider_ref:
|
dns_provider_ref:
|
||||||
description:
|
description:
|
||||||
- Dns profile for the cloud.
|
- Dns profile for the cloud.
|
||||||
|
@ -90,6 +92,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use static routes for vip side network resolution during virtualservice placement.
|
- Use static routes for vip side network resolution during virtualservice placement.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
ipam_provider_ref:
|
ipam_provider_ref:
|
||||||
description:
|
description:
|
||||||
- Ipam profile for the cloud.
|
- Ipam profile for the cloud.
|
||||||
|
@ -139,6 +142,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Prefer static routes over interface routes during virtualservice placement.
|
- Prefer static routes over interface routes during virtualservice placement.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
proxy_configuration:
|
proxy_configuration:
|
||||||
description:
|
description:
|
||||||
- Proxyconfiguration settings for cloud.
|
- Proxyconfiguration settings for cloud.
|
||||||
|
@ -151,6 +155,7 @@ options:
|
||||||
- Field introduced in 17.1.12.
|
- Field introduced in 17.1.12.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
|
|
@ -52,6 +52,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Re-join cluster nodes automatically in the event one of the node is reset to factory.
|
- Re-join cluster nodes automatically in the event one of the node is reset to factory.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
|
|
@ -46,14 +46,17 @@ options:
|
||||||
description:
|
description:
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
allow_unauthenticated_apis:
|
allow_unauthenticated_apis:
|
||||||
description:
|
description:
|
||||||
- Allow unauthenticated access for special apis.
|
- Allow unauthenticated access for special apis.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
allow_unauthenticated_nodes:
|
allow_unauthenticated_nodes:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set allow_unauthenticated_nodes.
|
- Boolean flag to set allow_unauthenticated_nodes.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
api_idle_timeout:
|
api_idle_timeout:
|
||||||
description:
|
description:
|
||||||
- Allowed values are 0-1440.
|
- Allowed values are 0-1440.
|
||||||
|
@ -64,6 +67,7 @@ options:
|
||||||
- Export configuration in appviewx compatibility mode.
|
- Export configuration in appviewx compatibility mode.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
attach_ip_retry_interval:
|
attach_ip_retry_interval:
|
||||||
description:
|
description:
|
||||||
- Number of attach_ip_retry_interval.
|
- Number of attach_ip_retry_interval.
|
||||||
|
@ -79,6 +83,7 @@ options:
|
||||||
- Field introduced in 17.2.2.
|
- Field introduced in 17.2.2.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
cluster_ip_gratuitous_arp_period:
|
cluster_ip_gratuitous_arp_period:
|
||||||
description:
|
description:
|
||||||
- Number of cluster_ip_gratuitous_arp_period.
|
- Number of cluster_ip_gratuitous_arp_period.
|
||||||
|
|
|
@ -53,6 +53,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Name of the dns policy.
|
- Name of the dns policy.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
|
required: true
|
||||||
rule:
|
rule:
|
||||||
description:
|
description:
|
||||||
- Dns rules.
|
- Dns rules.
|
||||||
|
@ -106,7 +107,7 @@ def main():
|
||||||
avi_api_patch_op=dict(choices=['add', 'replace', 'delete']),
|
avi_api_patch_op=dict(choices=['add', 'replace', 'delete']),
|
||||||
created_by=dict(type='str',),
|
created_by=dict(type='str',),
|
||||||
description=dict(type='str',),
|
description=dict(type='str',),
|
||||||
name=dict(type='str',),
|
name=dict(type='str', required=True),
|
||||||
rule=dict(type='list',),
|
rule=dict(type='list',),
|
||||||
tenant_ref=dict(type='str',),
|
tenant_ref=dict(type='str',),
|
||||||
url=dict(type='str',),
|
url=dict(type='str',),
|
||||||
|
|
|
@ -48,6 +48,7 @@ options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Field introduced in 17.2.4.
|
- Field introduced in 17.2.4.
|
||||||
|
required: true
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
@ -95,7 +96,7 @@ def main():
|
||||||
choices=['put', 'patch']),
|
choices=['put', 'patch']),
|
||||||
avi_api_patch_op=dict(choices=['add', 'replace', 'delete']),
|
avi_api_patch_op=dict(choices=['add', 'replace', 'delete']),
|
||||||
error_page_body=dict(type='str',),
|
error_page_body=dict(type='str',),
|
||||||
name=dict(type='str',),
|
name=dict(type='str', required=True),
|
||||||
tenant_ref=dict(type='str',),
|
tenant_ref=dict(type='str',),
|
||||||
url=dict(type='str',),
|
url=dict(type='str',),
|
||||||
uuid=dict(type='str',),
|
uuid=dict(type='str',),
|
||||||
|
|
|
@ -66,10 +66,12 @@ options:
|
||||||
- Field introduced in 17.1.3.
|
- Field introduced in 17.1.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
|
type: bool
|
||||||
leader_cluster_uuid:
|
leader_cluster_uuid:
|
||||||
description:
|
description:
|
||||||
- Mark this site as leader of gslb configuration.
|
- Mark this site as leader of gslb configuration.
|
||||||
- This site is the one among the avi sites.
|
- This site is the one among the avi sites.
|
||||||
|
required: true
|
||||||
maintenance_mode:
|
maintenance_mode:
|
||||||
description:
|
description:
|
||||||
- This field disables the configuration operations on the leader for all federated objects.
|
- This field disables the configuration operations on the leader for all federated objects.
|
||||||
|
@ -80,6 +82,7 @@ options:
|
||||||
- Field introduced in 17.2.1.
|
- Field introduced in 17.2.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name for the gslb object.
|
- Name for the gslb object.
|
||||||
|
@ -152,7 +155,7 @@ def main():
|
||||||
description=dict(type='str',),
|
description=dict(type='str',),
|
||||||
dns_configs=dict(type='list',),
|
dns_configs=dict(type='list',),
|
||||||
is_federated=dict(type='bool',),
|
is_federated=dict(type='bool',),
|
||||||
leader_cluster_uuid=dict(type='str',),
|
leader_cluster_uuid=dict(type='str', required=True),
|
||||||
maintenance_mode=dict(type='bool',),
|
maintenance_mode=dict(type='bool',),
|
||||||
name=dict(type='str', required=True),
|
name=dict(type='str', required=True),
|
||||||
send_interval=dict(type='int',),
|
send_interval=dict(type='int',),
|
||||||
|
|
|
@ -55,6 +55,7 @@ options:
|
||||||
- This field indicates that this object is replicated across gslb federation.
|
- This field indicates that this object is replicated across gslb federation.
|
||||||
- Field introduced in 17.1.3.
|
- Field introduced in 17.1.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- A user-friendly name for the geodb profile.
|
- A user-friendly name for the geodb profile.
|
||||||
|
|
|
@ -54,6 +54,7 @@ options:
|
||||||
- Note that the datapath status is determined by the association of health monitor profiles.
|
- Note that the datapath status is determined by the association of health monitor profiles.
|
||||||
- Only the controller provided status is determined through this configuration.
|
- Only the controller provided status is determined through this configuration.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
created_by:
|
created_by:
|
||||||
description:
|
description:
|
||||||
- Creator name.
|
- Creator name.
|
||||||
|
@ -73,6 +74,7 @@ options:
|
||||||
- If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm.
|
- If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm.
|
||||||
- If the gslb service is disabled, then the vips are no longer available in the dns response.
|
- If the gslb service is disabled, then the vips are no longer available in the dns response.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
groups:
|
groups:
|
||||||
description:
|
description:
|
||||||
- Select list of pools belonging to this gslb service.
|
- Select list of pools belonging to this gslb service.
|
||||||
|
@ -93,6 +95,7 @@ options:
|
||||||
- This field indicates that this object is replicated across gslb federation.
|
- This field indicates that this object is replicated across gslb federation.
|
||||||
- Field introduced in 17.1.3.
|
- Field introduced in 17.1.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
min_members:
|
min_members:
|
||||||
description:
|
description:
|
||||||
- The minimum number of members to distribute traffic to.
|
- The minimum number of members to distribute traffic to.
|
||||||
|
@ -124,6 +127,7 @@ options:
|
||||||
- Field introduced in 17.2.1.
|
- Field introduced in 17.2.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
@ -141,6 +145,7 @@ options:
|
||||||
- Default is true.
|
- Default is true.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
uuid:
|
uuid:
|
||||||
description:
|
description:
|
||||||
- Uuid of the gslb service.
|
- Uuid of the gslb service.
|
||||||
|
@ -151,6 +156,7 @@ options:
|
||||||
- Default is false.
|
- Default is false.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- avi
|
- avi
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -112,12 +112,12 @@ from copy import deepcopy
|
||||||
|
|
||||||
HAS_AVI = True
|
HAS_AVI = True
|
||||||
try:
|
try:
|
||||||
|
from ansible.module_utils.network.avi.avi import (
|
||||||
|
avi_common_argument_spec, HAS_AVI)
|
||||||
from avi.sdk.avi_api import ApiSession
|
from avi.sdk.avi_api import ApiSession
|
||||||
from avi.sdk.utils.ansible_utils import (
|
from avi.sdk.utils.ansible_utils import (
|
||||||
avi_obj_cmp, cleanup_absent_fields, ansible_return,
|
avi_obj_cmp, cleanup_absent_fields, ansible_return,
|
||||||
AviCheckModeResponse, AviCredentials)
|
AviCheckModeResponse, AviCredentials)
|
||||||
from ansible.module_utils.network.avi.avi import (
|
|
||||||
avi_common_argument_spec, HAS_AVI)
|
|
||||||
except ImportError:
|
except ImportError:
|
||||||
HAS_AVI = False
|
HAS_AVI = False
|
||||||
|
|
||||||
|
|
|
@ -70,6 +70,7 @@ options:
|
||||||
- Field introduced in 17.1.3.
|
- Field introduced in 17.1.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
|
type: bool
|
||||||
monitor_port:
|
monitor_port:
|
||||||
description:
|
description:
|
||||||
- Use this port instead of the port defined for the server in the pool.
|
- Use this port instead of the port defined for the server in the pool.
|
||||||
|
|
|
@ -65,6 +65,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set is_internal_policy.
|
- Boolean flag to set is_internal_policy.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the http policy set.
|
- Name of the http policy set.
|
||||||
|
|
|
@ -48,6 +48,7 @@ options:
|
||||||
- Field introduced in 17.2.4.
|
- Field introduced in 17.2.4.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
aws_profile:
|
aws_profile:
|
||||||
description:
|
description:
|
||||||
- Provider details if type is aws.
|
- Provider details if type is aws.
|
||||||
|
|
|
@ -52,10 +52,12 @@ options:
|
||||||
description:
|
description:
|
||||||
- Select the ip address management scheme for this network.
|
- Select the ip address management scheme for this network.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
exclude_discovered_subnets:
|
exclude_discovered_subnets:
|
||||||
description:
|
description:
|
||||||
- When selected, excludes all discovered subnets in this network from consideration for virtual service placement.
|
- When selected, excludes all discovered subnets in this network from consideration for virtual service placement.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the object.
|
- Name of the object.
|
||||||
|
@ -64,6 +66,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set synced_from_se.
|
- Boolean flag to set synced_from_se.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
@ -77,6 +80,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set vcenter_dvs.
|
- Boolean flag to set vcenter_dvs.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
vimgrnw_ref:
|
vimgrnw_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type vimgrnwruntime.
|
- It is a reference to an object of type vimgrnwruntime.
|
||||||
|
|
|
@ -52,6 +52,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked.
|
- When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
crls:
|
crls:
|
||||||
description:
|
description:
|
||||||
- Certificate revocation lists.
|
- Certificate revocation lists.
|
||||||
|
@ -60,6 +61,7 @@ options:
|
||||||
- When enabled, avi will not trust intermediate and root certs presented by a client.
|
- When enabled, avi will not trust intermediate and root certs presented by a client.
|
||||||
- Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert.
|
- Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
is_federated:
|
is_federated:
|
||||||
description:
|
description:
|
||||||
- This field describes the object's replication scope.
|
- This field describes the object's replication scope.
|
||||||
|
@ -68,6 +70,7 @@ options:
|
||||||
- Field introduced in 17.1.3.
|
- Field introduced in 17.1.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the pki profile.
|
- Name of the pki profile.
|
||||||
|
@ -86,6 +89,7 @@ options:
|
||||||
- When enabled, avi will only validate the revocation status of the leaf certificate using crl.
|
- When enabled, avi will only validate the revocation status of the leaf certificate using crl.
|
||||||
- To enable validation for the entire chain, disable this option and provide all the relevant crls.
|
- To enable validation for the entire chain, disable this option and provide all the relevant crls.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- avi
|
- avi
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -75,6 +75,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Inline estimation of capacity of servers.
|
- Inline estimation of capacity of servers.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
capacity_estimation_ttfb_thresh:
|
capacity_estimation_ttfb_thresh:
|
||||||
description:
|
description:
|
||||||
- The maximum time-to-first-byte of a server.
|
- The maximum time-to-first-byte of a server.
|
||||||
|
@ -116,11 +117,13 @@ options:
|
||||||
east_west:
|
east_west:
|
||||||
description:
|
description:
|
||||||
- Inherited config from virtualservice.
|
- Inherited config from virtualservice.
|
||||||
|
type: bool
|
||||||
enabled:
|
enabled:
|
||||||
description:
|
description:
|
||||||
- Enable or disable the pool.
|
- Enable or disable the pool.
|
||||||
- Disabling will terminate all open connections and pause health monitors.
|
- Disabling will terminate all open connections and pause health monitors.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
external_autoscale_groups:
|
external_autoscale_groups:
|
||||||
description:
|
description:
|
||||||
- Names of external auto-scale groups for pool servers.
|
- Names of external auto-scale groups for pool servers.
|
||||||
|
@ -149,6 +152,7 @@ options:
|
||||||
- Indicates if the pool is a site-persistence pool.
|
- Indicates if the pool is a site-persistence pool.
|
||||||
- Field introduced in 17.2.1.
|
- Field introduced in 17.2.1.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
health_monitor_refs:
|
health_monitor_refs:
|
||||||
description:
|
description:
|
||||||
- Verify server health by applying one or more health monitors.
|
- Verify server health by applying one or more health monitors.
|
||||||
|
@ -161,11 +165,13 @@ options:
|
||||||
- Enable common name check for server certificate.
|
- Enable common name check for server certificate.
|
||||||
- If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match.
|
- If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
inline_health_monitor:
|
inline_health_monitor:
|
||||||
description:
|
description:
|
||||||
- The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses.
|
- The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses.
|
||||||
- This may alter the expected behavior of the lb method, such as round robin.
|
- This may alter the expected behavior of the lb method, such as round robin.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
ipaddrgroup_ref:
|
ipaddrgroup_ref:
|
||||||
description:
|
description:
|
||||||
- Use list of servers from ip address group.
|
- Use list of servers from ip address group.
|
||||||
|
@ -199,6 +205,7 @@ options:
|
||||||
- Field introduced in 17.1.11,17.2.4.
|
- Field introduced in 17.1.11,17.2.4.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
max_concurrent_connections_per_server:
|
max_concurrent_connections_per_server:
|
||||||
description:
|
description:
|
||||||
- The maximum number of concurrent connections allowed to each server within the pool.
|
- The maximum number of concurrent connections allowed to each server within the pool.
|
||||||
|
@ -241,20 +248,24 @@ options:
|
||||||
description:
|
description:
|
||||||
- Enable request queue when pool is full.
|
- Enable request queue when pool is full.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
rewrite_host_header_to_server_name:
|
rewrite_host_header_to_server_name:
|
||||||
description:
|
description:
|
||||||
- Rewrite incoming host header to server name of the server to which the request is proxied.
|
- Rewrite incoming host header to server name of the server to which the request is proxied.
|
||||||
- Enabling this feature rewrites host header for requests to all servers in the pool.
|
- Enabling this feature rewrites host header for requests to all servers in the pool.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
rewrite_host_header_to_sni:
|
rewrite_host_header_to_sni:
|
||||||
description:
|
description:
|
||||||
- If sni server name is specified, rewrite incoming host header to the sni server name.
|
- If sni server name is specified, rewrite incoming host header to the sni server name.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
server_auto_scale:
|
server_auto_scale:
|
||||||
description:
|
description:
|
||||||
- Server autoscale.
|
- Server autoscale.
|
||||||
- Not used anymore.
|
- Not used anymore.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
server_count:
|
server_count:
|
||||||
description:
|
description:
|
||||||
- Number of server_count.
|
- Number of server_count.
|
||||||
|
@ -275,6 +286,7 @@ options:
|
||||||
- Enable tls sni for server connections.
|
- Enable tls sni for server connections.
|
||||||
- If disabled, avi will not send the sni extension as part of the handshake.
|
- If disabled, avi will not send the sni extension as part of the handshake.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
ssl_key_and_certificate_ref:
|
ssl_key_and_certificate_ref:
|
||||||
description:
|
description:
|
||||||
- Service engines will present a client ssl certificate to the server.
|
- Service engines will present a client ssl certificate to the server.
|
||||||
|
@ -295,6 +307,7 @@ options:
|
||||||
- Do not translate the client's destination port when sending the connection to the server.
|
- Do not translate the client's destination port when sending the connection to the server.
|
||||||
- The pool or servers specified service port will still be used for health monitoring.
|
- The pool or servers specified service port will still be used for health monitoring.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
uuid:
|
uuid:
|
||||||
description:
|
description:
|
||||||
- Uuid of the pool.
|
- Uuid of the pool.
|
||||||
|
|
|
@ -69,6 +69,7 @@ options:
|
||||||
- Field introduced in 17.1.9,17.2.3.
|
- Field introduced in 17.1.9,17.2.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
members:
|
members:
|
||||||
description:
|
description:
|
||||||
- List of pool group members object of type poolgroupmember.
|
- List of pool group members object of type poolgroupmember.
|
||||||
|
|
|
@ -45,6 +45,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- It will automatically disable old production pools once there is a new production candidate.
|
- It will automatically disable old production pools once there is a new production candidate.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
cloud_ref:
|
cloud_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type cloud.
|
- It is a reference to an object of type cloud.
|
||||||
|
|
|
@ -49,6 +49,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set enabled.
|
- Boolean flag to set enabled.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
end_date_time:
|
end_date_time:
|
||||||
description:
|
description:
|
||||||
- Scheduler end date and time.
|
- Scheduler end date and time.
|
||||||
|
|
|
@ -48,6 +48,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers.
|
- Use avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
intelligent_scalein_margin:
|
intelligent_scalein_margin:
|
||||||
description:
|
description:
|
||||||
- Maximum extra capacity as percentage of load used by the intelligent scheme.
|
- Maximum extra capacity as percentage of load used by the intelligent scheme.
|
||||||
|
@ -110,6 +111,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use predicted load rather than current load.
|
- Use predicted load rather than current load.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
uuid:
|
uuid:
|
||||||
description:
|
description:
|
||||||
- Unique object identifier of the object.
|
- Unique object identifier of the object.
|
||||||
|
|
|
@ -51,6 +51,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set container_mode.
|
- Boolean flag to set container_mode.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
container_type:
|
container_type:
|
||||||
description:
|
description:
|
||||||
- Enum options - container_type_bridge, container_type_host, container_type_host_dpdk.
|
- Enum options - container_type_bridge, container_type_host, container_type_host_dpdk.
|
||||||
|
@ -59,6 +60,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set controller_created.
|
- Boolean flag to set controller_created.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
controller_ip:
|
controller_ip:
|
||||||
description:
|
description:
|
||||||
- Controller_ip of serviceengine.
|
- Controller_ip of serviceengine.
|
||||||
|
|
|
@ -46,14 +46,17 @@ options:
|
||||||
description:
|
description:
|
||||||
- Service engines in active/standby mode for ha failover.
|
- Service engines in active/standby mode for ha failover.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
advertise_backend_networks:
|
advertise_backend_networks:
|
||||||
description:
|
description:
|
||||||
- Advertise reach-ability of backend server networks via adc through bgp for default gateway feature.
|
- Advertise reach-ability of backend server networks via adc through bgp for default gateway feature.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
aggressive_failure_detection:
|
aggressive_failure_detection:
|
||||||
description:
|
description:
|
||||||
- Enable aggressive failover configuration for ha.
|
- Enable aggressive failover configuration for ha.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
algo:
|
algo:
|
||||||
description:
|
description:
|
||||||
- In compact placement, virtual services are placed on existing ses until max_vs_per_se limit is reached.
|
- In compact placement, virtual services are placed on existing ses until max_vs_per_se limit is reached.
|
||||||
|
@ -64,6 +67,7 @@ options:
|
||||||
- Allow ses to be created using burst license.
|
- Allow ses to be created using burst license.
|
||||||
- Field introduced in 17.2.5.
|
- Field introduced in 17.2.5.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
archive_shm_limit:
|
archive_shm_limit:
|
||||||
description:
|
description:
|
||||||
- Amount of se memory in gb until which shared memory is collected in core archive.
|
- Amount of se memory in gb until which shared memory is collected in core archive.
|
||||||
|
@ -75,10 +79,11 @@ options:
|
||||||
- Ssl handshakes will be handled by dedicated ssl threads.
|
- Ssl handshakes will be handled by dedicated ssl threads.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
|
type: bool
|
||||||
async_ssl_threads:
|
async_ssl_threads:
|
||||||
description:
|
description:
|
||||||
- Number of async ssl threads per se_dp.
|
- Number of async ssl threads per se_dp.
|
||||||
- Allowed values are 1-4.
|
- Allowed values are 1-16.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
|
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
auto_rebalance:
|
auto_rebalance:
|
||||||
|
@ -86,6 +91,7 @@ options:
|
||||||
- If set, virtual services will be automatically migrated when load on an se is less than minimum or more than maximum thresholds.
|
- If set, virtual services will be automatically migrated when load on an se is less than minimum or more than maximum thresholds.
|
||||||
- Only alerts are generated when the auto_rebalance is not set.
|
- Only alerts are generated when the auto_rebalance is not set.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
auto_rebalance_capacity_per_se:
|
auto_rebalance_capacity_per_se:
|
||||||
description:
|
description:
|
||||||
- Capacities of se for auto rebalance for each criteria.
|
- Capacities of se for auto rebalance for each criteria.
|
||||||
|
@ -94,7 +100,7 @@ options:
|
||||||
auto_rebalance_criteria:
|
auto_rebalance_criteria:
|
||||||
description:
|
description:
|
||||||
- Set of criteria for se auto rebalance.
|
- Set of criteria for se auto rebalance.
|
||||||
- Enum options - SE_AUTO_REBALANCE_CPU, SE_AUTO_REBALANCE_PPS, SE_AUTO_REBALANCE_MBPS, SE_AUTO_REBALANCE_OPEN_CONNS.
|
- Enum options - SE_AUTO_REBALANCE_CPU, SE_AUTO_REBALANCE_PPS, SE_AUTO_REBALANCE_MBPS, SE_AUTO_REBALANCE_OPEN_CONNS, SE_AUTO_REBALANCE_CPS.
|
||||||
- Field introduced in 17.2.3.
|
- Field introduced in 17.2.3.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
auto_rebalance_interval:
|
auto_rebalance_interval:
|
||||||
|
@ -107,6 +113,7 @@ options:
|
||||||
- Redistribution of virtual services from the takeover se to the replacement se can cause momentary traffic loss.
|
- Redistribution of virtual services from the takeover se to the replacement se can cause momentary traffic loss.
|
||||||
- If the auto-redistribute load option is left in its default off state, any desired rebalancing requires calls to rest api.
|
- If the auto-redistribute load option is left in its default off state, any desired rebalancing requires calls to rest api.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
buffer_se:
|
buffer_se:
|
||||||
description:
|
description:
|
||||||
- Excess service engine capacity provisioned for ha failover.
|
- Excess service engine capacity provisioned for ha failover.
|
||||||
|
@ -125,11 +132,13 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set cpu_reserve.
|
- Boolean flag to set cpu_reserve.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
cpu_socket_affinity:
|
cpu_socket_affinity:
|
||||||
description:
|
description:
|
||||||
- Allocate all the cpu cores for the service engine virtual machines on the same cpu socket.
|
- Allocate all the cpu cores for the service engine virtual machines on the same cpu socket.
|
||||||
- Applicable only for vcenter cloud.
|
- Applicable only for vcenter cloud.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
custom_securitygroups_data:
|
custom_securitygroups_data:
|
||||||
description:
|
description:
|
||||||
- Custom security groups to be associated with data vnics for se instances in openstack and aws clouds.
|
- Custom security groups to be associated with data vnics for se instances in openstack and aws clouds.
|
||||||
|
@ -147,6 +156,7 @@ options:
|
||||||
- Dedicate the core that handles packet receive/transmit from the network to just the dispatching function.
|
- Dedicate the core that handles packet receive/transmit from the network to just the dispatching function.
|
||||||
- Don't use it for tcp/ip and ssl functions.
|
- Don't use it for tcp/ip and ssl functions.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- User defined description for the object.
|
- User defined description for the object.
|
||||||
|
@ -156,20 +166,23 @@ options:
|
||||||
- Field introduced in 17.1.14, 17.2.5.
|
- Field introduced in 17.1.14, 17.2.5.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
disable_gro:
|
disable_gro:
|
||||||
description:
|
description:
|
||||||
- Disable generic receive offload (gro) in dpdk poll-mode driver packet receive path.
|
- Disable generic receive offload (gro) in dpdk poll-mode driver packet receive path.
|
||||||
- Gro is on by default on nics that do not support lro (large receive offload) or do not gain performance boost from lro.
|
- Gro is on by default on nics that do not support lro (large receive offload) or do not gain performance boost from lro.
|
||||||
- Field introduced in 17.2.5.
|
- Field introduced in 17.2.5.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
disable_tso:
|
disable_tso:
|
||||||
description:
|
description:
|
||||||
- Disable tcp segmentation offload (tso) in dpdk poll-mode driver packet transmit path.
|
- Disable tcp segmentation offload (tso) in dpdk poll-mode driver packet transmit path.
|
||||||
- Tso is on by default on nics that support it.
|
- Tso is on by default on nics that support it.
|
||||||
- Field introduced in 17.2.5.
|
- Field introduced in 17.2.5.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
disk_per_se:
|
disk_per_se:
|
||||||
description:
|
description:
|
||||||
- Amount of disk space for each of the service engine virtual machines.
|
- Amount of disk space for each of the service engine virtual machines.
|
||||||
|
@ -179,19 +192,23 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use both the active and standby service engines for virtual service placement in the legacy active standby ha mode.
|
- Use both the active and standby service engines for virtual service placement in the legacy active standby ha mode.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
enable_routing:
|
enable_routing:
|
||||||
description:
|
description:
|
||||||
- Enable routing for this serviceenginegroup .
|
- Enable routing for this serviceenginegroup .
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
enable_vip_on_all_interfaces:
|
enable_vip_on_all_interfaces:
|
||||||
description:
|
description:
|
||||||
- Enable vip on all interfaces of se.
|
- Enable vip on all interfaces of se.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
enable_vmac:
|
enable_vmac:
|
||||||
description:
|
description:
|
||||||
- Use virtual mac address for interfaces on which floating interface ips are placed.
|
- Use virtual mac address for interfaces on which floating interface ips are placed.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
extra_config_multiplier:
|
extra_config_multiplier:
|
||||||
description:
|
description:
|
||||||
- Multiplier for extra config to support large vs/pool config.
|
- Multiplier for extra config to support large vs/pool config.
|
||||||
|
@ -230,6 +247,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Enable active health monitoring from the standby se for all placed virtual services.
|
- Enable active health monitoring from the standby se for all placed virtual services.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
host_attribute_key:
|
host_attribute_key:
|
||||||
description:
|
description:
|
||||||
- Key of a (key, value) pair identifying a label for a set of nodes usually in container clouds.
|
- Key of a (key, value) pair identifying a label for a set of nodes usually in container clouds.
|
||||||
|
@ -251,6 +269,7 @@ options:
|
||||||
- Field introduced in 17.2.4.
|
- Field introduced in 17.2.4.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
hypervisor:
|
hypervisor:
|
||||||
description:
|
description:
|
||||||
- Override default hypervisor.
|
- Override default hypervisor.
|
||||||
|
@ -286,6 +305,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Select core with least load for new flow.
|
- Select core with least load for new flow.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
license_tier:
|
license_tier:
|
||||||
description:
|
description:
|
||||||
- Specifies the license tier which would be used.
|
- Specifies the license tier which would be used.
|
||||||
|
@ -332,6 +352,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set mem_reserve.
|
- Boolean flag to set mem_reserve.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
memory_per_se:
|
memory_per_se:
|
||||||
description:
|
description:
|
||||||
- Amount of memory for each of the service engine virtual machines.
|
- Amount of memory for each of the service engine virtual machines.
|
||||||
|
@ -393,6 +414,7 @@ options:
|
||||||
- In this mode, each se is limited to a max of 2 vss.
|
- In this mode, each se is limited to a max of 2 vss.
|
||||||
- Vcpus in per-app ses count towards licensing usage at 25% rate.
|
- Vcpus in per-app ses count towards licensing usage at 25% rate.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
placement_mode:
|
placement_mode:
|
||||||
description:
|
description:
|
||||||
- If placement mode is 'auto', virtual services are automatically placed on service engines.
|
- If placement mode is 'auto', virtual services are automatically placed on service engines.
|
||||||
|
@ -446,6 +468,7 @@ options:
|
||||||
- Field introduced in 16.5.2, 17.1.9, 17.2.3.
|
- Field introduced in 16.5.2, 17.1.9, 17.2.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
se_sb_threads:
|
se_sb_threads:
|
||||||
description:
|
description:
|
||||||
- Number of sideband threads per se.
|
- Number of sideband threads per se.
|
||||||
|
@ -535,6 +558,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set vcenter_datastores_include.
|
- Boolean flag to set vcenter_datastores_include.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
vcenter_folder:
|
vcenter_folder:
|
||||||
description:
|
description:
|
||||||
- Folder to place all the service engine virtual machines in vcenter.
|
- Folder to place all the service engine virtual machines in vcenter.
|
||||||
|
@ -550,6 +574,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Ensure primary and secondary service engines are deployed on different physical hosts.
|
- Ensure primary and secondary service engines are deployed on different physical hosts.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
vs_scalein_timeout:
|
vs_scalein_timeout:
|
||||||
description:
|
description:
|
||||||
- Time to wait for the scaled in se to drain existing flows before marking the scalein done.
|
- Time to wait for the scaled in se to drain existing flows before marking the scalein done.
|
||||||
|
@ -576,6 +601,7 @@ options:
|
||||||
- Field introduced in 17.2.3.
|
- Field introduced in 17.2.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
waf_mempool_size:
|
waf_mempool_size:
|
||||||
description:
|
description:
|
||||||
- Memory pool size used for waf.
|
- Memory pool size used for waf.
|
||||||
|
|
|
@ -68,6 +68,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Enable ssl session re-use.
|
- Enable ssl session re-use.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the object.
|
- Name of the object.
|
||||||
|
@ -76,10 +77,12 @@ options:
|
||||||
description:
|
description:
|
||||||
- Prefer the ssl cipher ordering presented by the client during the ssl handshake over the one specified in the ssl profile.
|
- Prefer the ssl cipher ordering presented by the client during the ssl handshake over the one specified in the ssl profile.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
send_close_notify:
|
send_close_notify:
|
||||||
description:
|
description:
|
||||||
- Send 'close notify' alert message for a clean shutdown of the ssl connection.
|
- Send 'close notify' alert message for a clean shutdown of the ssl connection.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
ssl_rating:
|
ssl_rating:
|
||||||
description:
|
description:
|
||||||
- Sslrating settings for sslprofile.
|
- Sslrating settings for sslprofile.
|
||||||
|
|
|
@ -65,6 +65,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set docker_mode.
|
- Boolean flag to set docker_mode.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
email_configuration:
|
email_configuration:
|
||||||
description:
|
description:
|
||||||
- Emailconfiguration settings for systemconfiguration.
|
- Emailconfiguration settings for systemconfiguration.
|
||||||
|
|
|
@ -55,6 +55,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set local.
|
- Boolean flag to set local.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the object.
|
- Name of the object.
|
||||||
|
|
|
@ -58,6 +58,7 @@ options:
|
||||||
- Specifies if client ip needs to be preserved to clone destination.
|
- Specifies if client ip needs to be preserved to clone destination.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
|
|
@ -68,11 +68,13 @@ options:
|
||||||
- Auto-allocate floating/elastic ip from the cloud infrastructure.
|
- Auto-allocate floating/elastic ip from the cloud infrastructure.
|
||||||
- Field deprecated in 17.1.1.
|
- Field deprecated in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
auto_allocate_ip:
|
auto_allocate_ip:
|
||||||
description:
|
description:
|
||||||
- Auto-allocate vip from the provided subnet.
|
- Auto-allocate vip from the provided subnet.
|
||||||
- Field deprecated in 17.1.1.
|
- Field deprecated in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
availability_zone:
|
availability_zone:
|
||||||
description:
|
description:
|
||||||
- Availability-zone to place the virtual service.
|
- Availability-zone to place the virtual service.
|
||||||
|
@ -82,11 +84,13 @@ options:
|
||||||
- (internal-use) fip allocated by avi in the cloud infrastructure.
|
- (internal-use) fip allocated by avi in the cloud infrastructure.
|
||||||
- Field deprecated in 17.1.1.
|
- Field deprecated in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
avi_allocated_vip:
|
avi_allocated_vip:
|
||||||
description:
|
description:
|
||||||
- (internal-use) vip allocated by avi in the cloud infrastructure.
|
- (internal-use) vip allocated by avi in the cloud infrastructure.
|
||||||
- Field deprecated in 17.1.1.
|
- Field deprecated in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
client_auth:
|
client_auth:
|
||||||
description:
|
description:
|
||||||
- Http authentication configuration for protected resources.
|
- Http authentication configuration for protected resources.
|
||||||
|
@ -96,6 +100,7 @@ options:
|
||||||
- Field introduced in 17.2.4.
|
- Field introduced in 17.2.4.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
cloud_config_cksum:
|
cloud_config_cksum:
|
||||||
description:
|
description:
|
||||||
- Checksum of cloud configuration for vs.
|
- Checksum of cloud configuration for vs.
|
||||||
|
@ -122,6 +127,7 @@ options:
|
||||||
- Select the algorithm for qos fairness.
|
- Select the algorithm for qos fairness.
|
||||||
- This determines how multiple virtual services sharing the same service engines will prioritize traffic over a congested network.
|
- This determines how multiple virtual services sharing the same service engines will prioritize traffic over a congested network.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- User defined description for the object.
|
- User defined description for the object.
|
||||||
|
@ -154,20 +160,25 @@ options:
|
||||||
description:
|
description:
|
||||||
- Force placement on all se's in service group (mesos mode only).
|
- Force placement on all se's in service group (mesos mode only).
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
enable_autogw:
|
enable_autogw:
|
||||||
description:
|
description:
|
||||||
- Response traffic to clients will be sent back to the source mac address of the connection, rather than statically sent to a default gateway.
|
- Response traffic to clients will be sent back to the source mac address of the connection, rather than statically sent to a default gateway.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
enable_rhi:
|
enable_rhi:
|
||||||
description:
|
description:
|
||||||
- Enable route health injection using the bgp config in the vrf context.
|
- Enable route health injection using the bgp config in the vrf context.
|
||||||
|
type: bool
|
||||||
enable_rhi_snat:
|
enable_rhi_snat:
|
||||||
description:
|
description:
|
||||||
- Enable route health injection for source nat'ted floating ip address using the bgp config in the vrf context.
|
- Enable route health injection for source nat'ted floating ip address using the bgp config in the vrf context.
|
||||||
|
type: bool
|
||||||
enabled:
|
enabled:
|
||||||
description:
|
description:
|
||||||
- Enable or disable the virtual service.
|
- Enable or disable the virtual service.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
- Default value when not specified in API or module is interpreted by Avi Controller as True.
|
||||||
|
type: bool
|
||||||
error_page_profile_ref:
|
error_page_profile_ref:
|
||||||
description:
|
description:
|
||||||
- Error page profile to be used for this virtualservice.this profile is used to send the custom error page to the client generated by the proxy.
|
- Error page profile to be used for this virtualservice.this profile is used to send the custom error page to the client generated by the proxy.
|
||||||
|
@ -209,6 +220,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Ignore pool servers network reachability constraints for virtual service placement.
|
- Ignore pool servers network reachability constraints for virtual service placement.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
ip_address:
|
ip_address:
|
||||||
description:
|
description:
|
||||||
- Ip address of the virtual service.
|
- Ip address of the virtual service.
|
||||||
|
@ -221,6 +233,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Limit potential dos attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while.
|
- Limit potential dos attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
max_cps_per_client:
|
max_cps_per_client:
|
||||||
description:
|
description:
|
||||||
- Maximum connections per second per client ip.
|
- Maximum connections per second per client ip.
|
||||||
|
@ -272,6 +285,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Remove listening port if virtualservice is down.
|
- Remove listening port if virtualservice is down.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
requests_rate_limit:
|
requests_rate_limit:
|
||||||
description:
|
description:
|
||||||
- Rate limit the incoming requests to this virtual service.
|
- Rate limit the incoming requests to this virtual service.
|
||||||
|
@ -280,6 +294,7 @@ options:
|
||||||
- Disable re-distribution of flows across service engines for a virtual service.
|
- Disable re-distribution of flows across service engines for a virtual service.
|
||||||
- Enable if the network itself performs flow hashing with ecmp in environments such as gcp.
|
- Enable if the network itself performs flow hashing with ecmp in environments such as gcp.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
se_group_ref:
|
se_group_ref:
|
||||||
description:
|
description:
|
||||||
- The service engine group to use for this virtual service.
|
- The service engine group to use for this virtual service.
|
||||||
|
@ -364,6 +379,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use bridge ip as vip on each host in mesos deployments.
|
- Use bridge ip as vip on each host in mesos deployments.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
use_vip_as_snat:
|
use_vip_as_snat:
|
||||||
description:
|
description:
|
||||||
- Use the virtual ip as the snat ip for health monitoring and sending traffic to the backend servers instead of the service engine interface ip.
|
- Use the virtual ip as the snat ip for health monitoring and sending traffic to the backend servers instead of the service engine interface ip.
|
||||||
|
@ -372,6 +388,7 @@ options:
|
||||||
- Field introduced in 17.1.9,17.2.3.
|
- Field introduced in 17.1.9,17.2.3.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
|
type: bool
|
||||||
uuid:
|
uuid:
|
||||||
description:
|
description:
|
||||||
- Uuid of the virtualservice.
|
- Uuid of the virtualservice.
|
||||||
|
@ -398,7 +415,7 @@ options:
|
||||||
- Datascripts applied on the data traffic of the virtual service.
|
- Datascripts applied on the data traffic of the virtual service.
|
||||||
vsvip_ref:
|
vsvip_ref:
|
||||||
description:
|
description:
|
||||||
- Mostly used during the creation of shared vs, this fieldrefers to entities that can be shared across virtual services.
|
- Mostly used during the creation of shared vs, this field refers to entities that can be shared across virtual services.
|
||||||
- It is a reference to an object of type vsvip.
|
- It is a reference to an object of type vsvip.
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
|
|
|
@ -73,6 +73,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Boolean flag to set system_default.
|
- Boolean flag to set system_default.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
tenant_ref:
|
tenant_ref:
|
||||||
description:
|
description:
|
||||||
- It is a reference to an object of type tenant.
|
- It is a reference to an object of type tenant.
|
||||||
|
|
|
@ -55,6 +55,7 @@ options:
|
||||||
- Force placement on all service engines in the service engine group (container clouds only).
|
- Force placement on all service engines in the service engine group (container clouds only).
|
||||||
- Field introduced in 17.1.1.
|
- Field introduced in 17.1.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||||
|
type: bool
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name for the vsvip object.
|
- Name for the vsvip object.
|
||||||
|
|
|
@ -60,6 +60,7 @@ options:
|
||||||
- Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.
|
- Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.
|
||||||
- Field introduced in 17.2.1.
|
- Field introduced in 17.2.1.
|
||||||
- Default value when not specified in API or module is interpreted by Avi Controller as WAF_MODE_DETECTION_ONLY.
|
- Default value when not specified in API or module is interpreted by Avi Controller as WAF_MODE_DETECTION_ONLY.
|
||||||
|
required: true
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Field introduced in 17.2.1.
|
- Field introduced in 17.2.1.
|
||||||
|
@ -96,6 +97,7 @@ options:
|
||||||
- Waf profile for waf policy.
|
- Waf profile for waf policy.
|
||||||
- It is a reference to an object of type wafprofile.
|
- It is a reference to an object of type wafprofile.
|
||||||
- Field introduced in 17.2.1.
|
- Field introduced in 17.2.1.
|
||||||
|
required: true
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- avi
|
- avi
|
||||||
'''
|
'''
|
||||||
|
@ -135,7 +137,7 @@ def main():
|
||||||
created_by=dict(type='str',),
|
created_by=dict(type='str',),
|
||||||
crs_groups=dict(type='list',),
|
crs_groups=dict(type='list',),
|
||||||
description=dict(type='str',),
|
description=dict(type='str',),
|
||||||
mode=dict(type='str',),
|
mode=dict(type='str', required=True),
|
||||||
name=dict(type='str', required=True),
|
name=dict(type='str', required=True),
|
||||||
paranoia_level=dict(type='str',),
|
paranoia_level=dict(type='str',),
|
||||||
post_crs_groups=dict(type='list',),
|
post_crs_groups=dict(type='list',),
|
||||||
|
@ -143,7 +145,7 @@ def main():
|
||||||
tenant_ref=dict(type='str',),
|
tenant_ref=dict(type='str',),
|
||||||
url=dict(type='str',),
|
url=dict(type='str',),
|
||||||
uuid=dict(type='str',),
|
uuid=dict(type='str',),
|
||||||
waf_profile_ref=dict(type='str',),
|
waf_profile_ref=dict(type='str', required=True),
|
||||||
)
|
)
|
||||||
argument_specs.update(avi_common_argument_spec())
|
argument_specs.update(avi_common_argument_spec())
|
||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
|
|
|
@ -28,12 +28,15 @@ options:
|
||||||
controller:
|
controller:
|
||||||
description:
|
description:
|
||||||
- IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER).
|
- IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER).
|
||||||
|
default: ''
|
||||||
username:
|
username:
|
||||||
description:
|
description:
|
||||||
- Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME).
|
- Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME).
|
||||||
|
default: ''
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD).
|
- Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD).
|
||||||
|
default: ''
|
||||||
tenant:
|
tenant:
|
||||||
description:
|
description:
|
||||||
- Name of tenant used for all Avi API calls and context of object.
|
- Name of tenant used for all Avi API calls and context of object.
|
||||||
|
@ -45,6 +48,7 @@ options:
|
||||||
api_version:
|
api_version:
|
||||||
description:
|
description:
|
||||||
- Avi API version of to use for Avi API and objects.
|
- Avi API version of to use for Avi API and objects.
|
||||||
|
default: "16.4.4"
|
||||||
avi_credentials:
|
avi_credentials:
|
||||||
description:
|
description:
|
||||||
- Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
- Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
||||||
|
|
Loading…
Reference in a new issue