diff --git a/lib/ansible/modules/network/avi/avi_actiongroupconfig.py b/lib/ansible/modules/network/avi/avi_actiongroupconfig.py index 40b0fc98176..2b3184e072c 100644 --- a/lib/ansible/modules/network/avi/avi_actiongroupconfig.py +++ b/lib/ansible/modules/network/avi/avi_actiongroupconfig.py @@ -49,6 +49,7 @@ options: description: - Trigger notification to autoscale manager. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool description: description: - User defined description for the object. @@ -61,6 +62,7 @@ options: - Generate alert only to external destinations. - Default value when not specified in API or module is interpreted by Avi Controller as False. required: true + type: bool level: description: - When an alert is generated, mark its priority via the alert level. diff --git a/lib/ansible/modules/network/avi/avi_alertconfig.py b/lib/ansible/modules/network/avi/avi_alertconfig.py index bc149d3a286..c8821ffc3d3 100644 --- a/lib/ansible/modules/network/avi/avi_alertconfig.py +++ b/lib/ansible/modules/network/avi/avi_alertconfig.py @@ -52,6 +52,7 @@ options: autoscale_alert: description: - This alert config applies to auto scale alerts. + type: bool category: description: - 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: - 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. + type: bool expiry_time: description: - 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, - AUTHPROFILE, CLOUD, SERVERAUTOSCALEPOLICY, AUTOSCALELAUNCHCONFIG, MICROSERVICEGROUP, IPAMPROFILE, HARDWARESECURITYMODULEGROUP, POOLGROUP, - PRIORITYLABELS, POOLGROUPDEPLOYMENTPOLICY, GSLBSERVICE, GSLBSERVICERUNTIME, SCHEDULER, GSLBGEODBPROFILE, GSLBAPPLICATIONPERSISTENCEPROFILE, - - TRAFFICCLONEPROFILE, VSVIP, WAFPOLICY, WAFPROFILE, ERRORPAGEPROFILE, ERRORPAGEBODY, SERVICEENGINE, DEBUGSERVICEENGINE, DEBUGCONTROLLER, - - DEBUGVIRTUALSERVICE, SERVICEENGINEGROUP, SEPROPERTIES, NETWORK, CONTROLLERNODE, CONTROLLERPROPERTIES, SYSTEMCONFIGURATION, VRFCONTEXT, USER, - - ALERTCONFIG, ALERTSYSLOGCONFIG, ALERTEMAILCONFIG, ALERTTYPECONFIG, APPLICATION, ROLE, CLOUDPROPERTIES, SNMPTRAPPROFILE, ACTIONGROUPPROFILE, - - MICROSERVICE, ALERTPARAMS, ACTIONGROUPCONFIG, CLOUDCONNECTORUSER, GSLB, GSLBDNSUPDATE, GSLBSITEOPS, GLBMGRWARMSTART, IPAMDNSRECORD, - - GSLBDNSGSSTATUS, GSLBDNSGEOFILEOPS, GSLBDNSGEOUPDATE, GSLBDNSGEOCLUSTEROPS, GSLBDNSCLEANUP, GSLBSITEOPSRESYNC, TCPSTATRUNTIME, UDPSTATRUNTIME, - - IPSTATRUNTIME, ARPSTATRUNTIME, MBSTATRUNTIME, IPSTKQSTATSRUNTIME, MALLOCSTATRUNTIME, SHMALLOCSTATRUNTIME, CPUUSAGERUNTIME, L7GLOBALSTATSRUNTIME, - - L7VIRTUALSERVICESTATSRUNTIME, SEAGENTVNICDBRUNTIME, SEAGENTGRAPHDBRUNTIME, SEAGENTSTATERUNTIME, INTERFACERUNTIME, ARPTABLERUNTIME, - - DISPATCHERSTATRUNTIME, DISPATCHERSTATCLEARRUNTIME, DISPATCHERTABLEDUMPRUNTIME, DISPATCHERREMOTETIMERLISTDUMPRUNTIME, METRICSAGENTMESSAGE, - - HEALTHMONITORSTATRUNTIME, METRICSENTITYRUNTIME, PERSISTENCEINTERNAL, HTTPPOLICYSETINTERNAL, DNSPOLICYINTERNAL, CONNECTIONDUMPRUNTIME, - - SHAREDDBSTATS, SHAREDDBSTATSCLEAR, ICMPSTATRUNTIME, ROUTETABLERUNTIME, VIRTUALMACHINE, POOLSERVER, SEVSLIST, MEMINFORUNTIME, RTERINGSTATRUNTIME, - - ALGOSTATRUNTIME, HEALTHMONITORRUNTIME, CPUSTATRUNTIME, SEVM, HOST, PORTGROUP, CLUSTER, DATACENTER, VCENTER, HTTPPOLICYSETSTATS, DNSPOLICYSTATS, - - METRICSSESTATS, RATELIMITERSTATRUNTIME, NETWORKSECURITYPOLICYSTATS, TCPCONNRUNTIME, POOLSTATS, CONNPOOLINTERNAL, CONNPOOLSTATS, VSHASHSHOWRUNTIME, - - SELOGSTATSRUNTIME, NETWORKSECURITYPOLICYDETAIL, LICENSERUNTIME, SERVERRUNTIME, METRICSRUNTIMESUMMARY, METRICSRUNTIMEDETAIL, - - DISPATCHERSEHMPROBETEMPDISABLERUNTIME, POOLDEBUG, VSLOGMGRMAP, SERUMINSERTIONSTATS, HTTPCACHE, HTTPCACHESTATS, SEDOSSTATRUNTIME, VSDOSSTATRUNTIME, - - SERVERUPDATEREQ, VSSCALEOUTLIST, SEMEMDISTRUNTIME, TCPCONNRUNTIMEDETAIL, SEUPGRADESTATUS, SEUPGRADEPREVIEW, SEFAULTINJECTEXHAUSTM, - - SEFAULTINJECTEXHAUSTMCL, SEFAULTINJECTEXHAUSTMCLSMALL, SEFAULTINJECTEXHAUSTCONN, SEHEADLESSONLINEREQ, SEUPGRADE, SEUPGRADESTATUSDETAIL, - - SERESERVEDVS, SERESERVEDVSCLEAR, VSCANDIDATESEHOSTLIST, SEGROUPUPGRADE, REBALANCE, SEGROUPREBALANCE, SEAUTHSTATSRUNTIME, AUTOSCALESTATE, - - VIRTUALSERVICEAUTHSTATS, NETWORKSECURITYPOLICYDOS, KEYVALINTERNAL, KEYVALSUMMARYINTERNAL, SERVERSTATEUPDATEINFO, CLTRACKINTERNAL, - - CLTRACKSUMMARYINTERNAL, MICROSERVICERUNTIME, SEMICROSERVICE, VIRTUALSERVICEANALYSIS, CLIENTINTERNAL, CLIENTSUMMARYINTERNAL, - - MICROSERVICEGROUPRUNTIME, BGPRUNTIME, REQUESTQUEUERUNTIME, MIGRATEALL, MIGRATEALLSTATUSSUMMARY, MIGRATEALLSTATUSDETAIL, INTERFACESUMMARYRUNTIME, - - INTERFACELACPRUNTIME, DNSTABLE, GSLBSERVICEDETAIL, GSLBSERVICEINTERNAL, GSLBSERVICEHMONSTAT, SETROLESREQUEST, TRAFFICCLONERUNTIME, - - GEOLOCATIONINFO, SEVSHBSTATRUNTIME, GEODBINTERNAL, GSLBSITEINTERNAL, WAFSTATS, USERDEFINEDDATASCRIPTCOUNTERS, LLDPRUNTIME, VSESSHARINGPOOL, - - SEVSSPLACEMENT, SERESOURCEPROTO, SECONSUMERPROTO, SECREATEPENDINGPROTO, PLACEMENTSTATS, SEVIPPROTO, RMVRFPROTO, VCENTERMAP, VIMGRVCENTERRUNTIME, - - INTERESTEDVMS, INTERESTEDHOSTS, VCENTERSUPPORTEDCOUNTERS, ENTITYCOUNTERS, TRANSACTIONSTATS, SEVMCREATEPROGRESS, PLACEMENTSTATUS, VISUBFOLDERS, - - VIDATASTORE, VIHOSTRESOURCES, CLOUDCONNECTOR, VINETWORKSUBNETVMS, VIDATASTORECONTENTS, VIMGRVCENTERCLOUDRUNTIME, VIVCENTERPORTGROUPS, - - VIVCENTERDATACENTERS, VIMGRHOSTRUNTIME, PLACEMENTGLOBALS, APICCONFIGURATION, CIFTABLE, APICTRANSACTION, VIRTUALSERVICESTATEDBCACHESUMMARY, - - POOLSTATEDBCACHESUMMARY, SERVERSTATEDBCACHESUMMARY, APICAGENTINTERNAL, APICTRANSACTIONFLAP, APICGRAPHINSTANCES, APICEPGS, APICEPGEPS, - - APICDEVICEPKGVER, APICTENANTS, APICVMMDOMAINS, NSXCONFIGURATION, NSXSGTABLE, NSXAGENTINTERNAL, NSXSGINFO, NSXSGIPS, NSXAGENTINTERNALCLI, - - MAXOBJECTS. + - TRAFFICCLONEPROFILE, VSVIP, WAFPOLICY, WAFPROFILE, ERRORPAGEPROFILE, ERRORPAGEBODY, L4POLICYSET, SERVICEENGINE, DEBUGSERVICEENGINE, + - DEBUGCONTROLLER, DEBUGVIRTUALSERVICE, SERVICEENGINEGROUP, SEPROPERTIES, NETWORK, CONTROLLERNODE, CONTROLLERPROPERTIES, SYSTEMCONFIGURATION, + - VRFCONTEXT, USER, ALERTCONFIG, ALERTSYSLOGCONFIG, ALERTEMAILCONFIG, ALERTTYPECONFIG, APPLICATION, ROLE, CLOUDPROPERTIES, SNMPTRAPPROFILE, + - ACTIONGROUPPROFILE, MICROSERVICE, ALERTPARAMS, ACTIONGROUPCONFIG, CLOUDCONNECTORUSER, GSLB, GSLBDNSUPDATE, GSLBSITEOPS, GLBMGRWARMSTART, + - IPAMDNSRECORD, GSLBDNSGSSTATUS, GSLBDNSGEOFILEOPS, GSLBDNSGEOUPDATE, GSLBDNSGEOCLUSTEROPS, GSLBDNSCLEANUP, GSLBSITEOPSRESYNC, TCPSTATRUNTIME, + - UDPSTATRUNTIME, IPSTATRUNTIME, ARPSTATRUNTIME, MBSTATRUNTIME, IPSTKQSTATSRUNTIME, MALLOCSTATRUNTIME, SHMALLOCSTATRUNTIME, CPUUSAGERUNTIME, + - L7GLOBALSTATSRUNTIME, L7VIRTUALSERVICESTATSRUNTIME, SEAGENTVNICDBRUNTIME, SEAGENTGRAPHDBRUNTIME, SEAGENTSTATERUNTIME, INTERFACERUNTIME, + - ARPTABLERUNTIME, DISPATCHERSTATRUNTIME, DISPATCHERSTATCLEARRUNTIME, DISPATCHERTABLEDUMPRUNTIME, DISPATCHERREMOTETIMERLISTDUMPRUNTIME, + - METRICSAGENTMESSAGE, HEALTHMONITORSTATRUNTIME, METRICSENTITYRUNTIME, PERSISTENCEINTERNAL, HTTPPOLICYSETINTERNAL, DNSPOLICYINTERNAL, + - CONNECTIONDUMPRUNTIME, SHAREDDBSTATS, SHAREDDBSTATSCLEAR, ICMPSTATRUNTIME, ROUTETABLERUNTIME, VIRTUALMACHINE, POOLSERVER, SEVSLIST, + - MEMINFORUNTIME, RTERINGSTATRUNTIME, ALGOSTATRUNTIME, HEALTHMONITORRUNTIME, CPUSTATRUNTIME, SEVM, HOST, PORTGROUP, CLUSTER, DATACENTER, VCENTER, + - HTTPPOLICYSETSTATS, DNSPOLICYSTATS, METRICSSESTATS, RATELIMITERSTATRUNTIME, NETWORKSECURITYPOLICYSTATS, TCPCONNRUNTIME, POOLSTATS, + - CONNPOOLINTERNAL, CONNPOOLSTATS, VSHASHSHOWRUNTIME, SELOGSTATSRUNTIME, NETWORKSECURITYPOLICYDETAIL, LICENSERUNTIME, SERVERRUNTIME, + - METRICSRUNTIMESUMMARY, METRICSRUNTIMEDETAIL, DISPATCHERSEHMPROBETEMPDISABLERUNTIME, POOLDEBUG, VSLOGMGRMAP, SERUMINSERTIONSTATS, HTTPCACHE, + - HTTPCACHESTATS, SEDOSSTATRUNTIME, VSDOSSTATRUNTIME, SERVERUPDATEREQ, VSSCALEOUTLIST, SEMEMDISTRUNTIME, TCPCONNRUNTIMEDETAIL, SEUPGRADESTATUS, + - SEUPGRADEPREVIEW, SEFAULTINJECTEXHAUSTM, SEFAULTINJECTEXHAUSTMCL, SEFAULTINJECTEXHAUSTMCLSMALL, SEFAULTINJECTEXHAUSTCONN, SEHEADLESSONLINEREQ, + - SEUPGRADE, SEUPGRADESTATUSDETAIL, SERESERVEDVS, SERESERVEDVSCLEAR, VSCANDIDATESEHOSTLIST, SEGROUPUPGRADE, REBALANCE, SEGROUPREBALANCE, + - SEAUTHSTATSRUNTIME, AUTOSCALESTATE, VIRTUALSERVICEAUTHSTATS, NETWORKSECURITYPOLICYDOS, KEYVALINTERNAL, KEYVALSUMMARYINTERNAL, + - SERVERSTATEUPDATEINFO, CLTRACKINTERNAL, CLTRACKSUMMARYINTERNAL, MICROSERVICERUNTIME, SEMICROSERVICE, VIRTUALSERVICEANALYSIS, CLIENTINTERNAL, + - CLIENTSUMMARYINTERNAL, MICROSERVICEGROUPRUNTIME, BGPRUNTIME, REQUESTQUEUERUNTIME, MIGRATEALL, MIGRATEALLSTATUSSUMMARY, MIGRATEALLSTATUSDETAIL, + - INTERFACESUMMARYRUNTIME, INTERFACELACPRUNTIME, DNSTABLE, GSLBSERVICEDETAIL, GSLBSERVICEINTERNAL, GSLBSERVICEHMONSTAT, SETROLESREQUEST, + - TRAFFICCLONERUNTIME, GEOLOCATIONINFO, SEVSHBSTATRUNTIME, GEODBINTERNAL, GSLBSITEINTERNAL, WAFSTATS, USERDEFINEDDATASCRIPTCOUNTERS, LLDPRUNTIME, + - VSESSHARINGPOOL, SEVSSPLACEMENT, L4POLICYSETSTATS, L4POLICYSETINTERNAL, SERESOURCEPROTO, SECONSUMERPROTO, SECREATEPENDINGPROTO, PLACEMENTSTATS, + - SEVIPPROTO, RMVRFPROTO, VCENTERMAP, VIMGRVCENTERRUNTIME, INTERESTEDVMS, INTERESTEDHOSTS, VCENTERSUPPORTEDCOUNTERS, ENTITYCOUNTERS, + - TRANSACTIONSTATS, SEVMCREATEPROGRESS, PLACEMENTSTATUS, VISUBFOLDERS, VIDATASTORE, VIHOSTRESOURCES, CLOUDCONNECTOR, VINETWORKSUBNETVMS, + - VIDATASTORECONTENTS, VIMGRVCENTERCLOUDRUNTIME, VIVCENTERPORTGROUPS, VIVCENTERDATACENTERS, VIMGRHOSTRUNTIME, PLACEMENTGLOBALS, APICCONFIGURATION, + - CIFTABLE, APICTRANSACTION, VIRTUALSERVICESTATEDBCACHESUMMARY, POOLSTATEDBCACHESUMMARY, SERVERSTATEDBCACHESUMMARY, APICAGENTINTERNAL, + - APICTRANSACTIONFLAP, APICGRAPHINSTANCES, APICEPGS, APICEPGEPS, APICDEVICEPKGVER, APICTENANTS, APICVMMDOMAINS, NSXCONFIGURATION, NSXSGTABLE, + - NSXAGENTINTERNAL, NSXSGINFO, NSXSGIPS, NSXAGENTINTERNALCLI, MAXOBJECTS. recommendation: description: - Recommendation of alertconfig. diff --git a/lib/ansible/modules/network/avi/avi_analyticsprofile.py b/lib/ansible/modules/network/avi/avi_analyticsprofile.py index 606bbfec609..a3687e9b428 100644 --- a/lib/ansible/modules/network/avi/avi_analyticsprofile.py +++ b/lib/ansible/modules/network/avi/avi_analyticsprofile.py @@ -171,25 +171,30 @@ options: description: - Disable node (service engine) level analytics forvs metrics. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool disable_server_analytics: description: - Disable analytics on backend 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. + type: bool exclude_client_close_before_request_as_error: description: - 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. + type: bool exclude_dns_policy_drop_as_significant: description: - Exclude dns policy drops from the list of errors. - Field introduced in 17.2.2. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool exclude_gs_down_as_error: description: - 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. + type: bool exclude_http_error_codes: description: - List of http status codes to be excluded from being classified as an error. @@ -198,43 +203,53 @@ options: description: - 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. + type: bool exclude_invalid_dns_query_as_error: description: - 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. + type: bool exclude_no_dns_record_as_error: description: - 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. + type: bool exclude_no_valid_gs_member_as_error: description: - 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. + type: bool exclude_persistence_change_as_error: description: - 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. + type: bool exclude_server_dns_error_as_error: description: - 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. + type: bool exclude_server_tcp_reset_as_error: description: - Exclude server tcp reset from errors. - It is common for applications like ms exchange. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool exclude_syn_retransmit_as_error: description: - 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. + type: bool exclude_tcp_reset_as_error: description: - 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. + type: bool exclude_unsupported_dns_query_as_error: description: - 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. + type: bool hs_event_throttle_window: description: - Time window (in secs) within which only unique health change events should occur. diff --git a/lib/ansible/modules/network/avi/avi_api_session.py b/lib/ansible/modules/network/avi/avi_api_session.py index 8dcddd34997..8f650904511 100644 --- a/lib/ansible/modules/network/avi/avi_api_session.py +++ b/lib/ansible/modules/network/avi/avi_api_session.py @@ -45,6 +45,7 @@ options: timeout: description: - Timeout (in seconds) for Avi API calls. + default: 60 extends_documentation_fragment: - avi ''' diff --git a/lib/ansible/modules/network/avi/avi_applicationpersistenceprofile.py b/lib/ansible/modules/network/avi/avi_applicationpersistenceprofile.py index a51698b02e2..887a5cbf4ad 100644 --- a/lib/ansible/modules/network/avi/avi_applicationpersistenceprofile.py +++ b/lib/ansible/modules/network/avi/avi_applicationpersistenceprofile.py @@ -65,6 +65,7 @@ options: - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.4" + type: bool name: description: - A user-friendly name for the persistence profile. diff --git a/lib/ansible/modules/network/avi/avi_applicationprofile.py b/lib/ansible/modules/network/avi/avi_applicationprofile.py index 83f9fefb5db..083fd4a21e4 100644 --- a/lib/ansible/modules/network/avi/avi_applicationprofile.py +++ b/lib/ansible/modules/network/avi/avi_applicationprofile.py @@ -63,6 +63,7 @@ options: - Specifies if client ip needs to be preserved for backend connection. - Not compatible with connection multiplexing. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool tcp_app_profile: description: - Specifies the tcp application proxy profile parameters. diff --git a/lib/ansible/modules/network/avi/avi_backupconfiguration.py b/lib/ansible/modules/network/avi/avi_backupconfiguration.py index d448f53f5b7..37add350b97 100644 --- a/lib/ansible/modules/network/avi/avi_backupconfiguration.py +++ b/lib/ansible/modules/network/avi/avi_backupconfiguration.py @@ -66,6 +66,7 @@ options: save_local: description: - Local backup. + type: bool ssh_user_ref: description: - Access credentials for remote destination. @@ -76,6 +77,7 @@ options: upload_to_remote_host: description: - Remote backup. + type: bool url: description: - Avi controller URL of the object. diff --git a/lib/ansible/modules/network/avi/avi_cloud.py b/lib/ansible/modules/network/avi/avi_cloud.py index 6d9ebceedc0..92bed828ad9 100644 --- a/lib/ansible/modules/network/avi/avi_cloud.py +++ b/lib/ansible/modules/network/avi/avi_cloud.py @@ -49,6 +49,7 @@ options: description: - Boolean flag to set apic_mode. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool aws_configuration: description: - Awsconfiguration settings for cloud. @@ -68,6 +69,7 @@ options: description: - Select the ip address management scheme. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool dns_provider_ref: description: - Dns profile for the cloud. @@ -90,6 +92,7 @@ options: description: - 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. + type: bool ipam_provider_ref: description: - Ipam profile for the cloud. @@ -139,6 +142,7 @@ options: description: - 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. + type: bool proxy_configuration: description: - Proxyconfiguration settings for cloud. @@ -151,6 +155,7 @@ options: - Field introduced in 17.1.12. - Default value when not specified in API or module is interpreted by Avi Controller as True. version_added: "2.5" + type: bool tenant_ref: description: - It is a reference to an object of type tenant. diff --git a/lib/ansible/modules/network/avi/avi_cluster.py b/lib/ansible/modules/network/avi/avi_cluster.py index 73943bd7cf7..df06eafb539 100644 --- a/lib/ansible/modules/network/avi/avi_cluster.py +++ b/lib/ansible/modules/network/avi/avi_cluster.py @@ -52,6 +52,7 @@ options: description: - 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. + type: bool tenant_ref: description: - It is a reference to an object of type tenant. diff --git a/lib/ansible/modules/network/avi/avi_controllerproperties.py b/lib/ansible/modules/network/avi/avi_controllerproperties.py index 8bc4ace9f91..1cd8d42e4af 100644 --- a/lib/ansible/modules/network/avi/avi_controllerproperties.py +++ b/lib/ansible/modules/network/avi/avi_controllerproperties.py @@ -46,14 +46,17 @@ options: description: - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool allow_unauthenticated_apis: description: - Allow unauthenticated access for special apis. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool allow_unauthenticated_nodes: description: - Boolean flag to set allow_unauthenticated_nodes. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool api_idle_timeout: description: - Allowed values are 0-1440. @@ -64,6 +67,7 @@ options: - Export configuration in appviewx compatibility mode. - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool attach_ip_retry_interval: description: - Number of attach_ip_retry_interval. @@ -79,6 +83,7 @@ options: - Field introduced in 17.2.2. - Default value when not specified in API or module is interpreted by Avi Controller as True. version_added: "2.5" + type: bool cluster_ip_gratuitous_arp_period: description: - Number of cluster_ip_gratuitous_arp_period. diff --git a/lib/ansible/modules/network/avi/avi_dnspolicy.py b/lib/ansible/modules/network/avi/avi_dnspolicy.py index feb02f3a143..4206039e66c 100644 --- a/lib/ansible/modules/network/avi/avi_dnspolicy.py +++ b/lib/ansible/modules/network/avi/avi_dnspolicy.py @@ -53,6 +53,7 @@ options: description: - Name of the dns policy. - Field introduced in 17.1.1. + required: true rule: description: - Dns rules. @@ -106,7 +107,7 @@ def main(): avi_api_patch_op=dict(choices=['add', 'replace', 'delete']), created_by=dict(type='str',), description=dict(type='str',), - name=dict(type='str',), + name=dict(type='str', required=True), rule=dict(type='list',), tenant_ref=dict(type='str',), url=dict(type='str',), diff --git a/lib/ansible/modules/network/avi/avi_errorpagebody.py b/lib/ansible/modules/network/avi/avi_errorpagebody.py index 05d7e1ca1fb..f49a168fe6c 100644 --- a/lib/ansible/modules/network/avi/avi_errorpagebody.py +++ b/lib/ansible/modules/network/avi/avi_errorpagebody.py @@ -48,6 +48,7 @@ options: name: description: - Field introduced in 17.2.4. + required: true tenant_ref: description: - It is a reference to an object of type tenant. @@ -95,7 +96,7 @@ def main(): choices=['put', 'patch']), avi_api_patch_op=dict(choices=['add', 'replace', 'delete']), error_page_body=dict(type='str',), - name=dict(type='str',), + name=dict(type='str', required=True), tenant_ref=dict(type='str',), url=dict(type='str',), uuid=dict(type='str',), diff --git a/lib/ansible/modules/network/avi/avi_gslb.py b/lib/ansible/modules/network/avi/avi_gslb.py index ae8d1bad56b..70228398615 100644 --- a/lib/ansible/modules/network/avi/avi_gslb.py +++ b/lib/ansible/modules/network/avi/avi_gslb.py @@ -66,10 +66,12 @@ options: - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as True. version_added: "2.4" + type: bool leader_cluster_uuid: description: - Mark this site as leader of gslb configuration. - This site is the one among the avi sites. + required: true maintenance_mode: description: - This field disables the configuration operations on the leader for all federated objects. @@ -80,6 +82,7 @@ options: - Field introduced in 17.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool name: description: - Name for the gslb object. @@ -152,7 +155,7 @@ def main(): description=dict(type='str',), dns_configs=dict(type='list',), is_federated=dict(type='bool',), - leader_cluster_uuid=dict(type='str',), + leader_cluster_uuid=dict(type='str', required=True), maintenance_mode=dict(type='bool',), name=dict(type='str', required=True), send_interval=dict(type='int',), diff --git a/lib/ansible/modules/network/avi/avi_gslbgeodbprofile.py b/lib/ansible/modules/network/avi/avi_gslbgeodbprofile.py index 09888643cf9..29735340eec 100644 --- a/lib/ansible/modules/network/avi/avi_gslbgeodbprofile.py +++ b/lib/ansible/modules/network/avi/avi_gslbgeodbprofile.py @@ -55,6 +55,7 @@ options: - This field indicates that this object is replicated across gslb federation. - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool name: description: - A user-friendly name for the geodb profile. diff --git a/lib/ansible/modules/network/avi/avi_gslbservice.py b/lib/ansible/modules/network/avi/avi_gslbservice.py index c7e9252e21e..2851c673f03 100644 --- a/lib/ansible/modules/network/avi/avi_gslbservice.py +++ b/lib/ansible/modules/network/avi/avi_gslbservice.py @@ -54,6 +54,7 @@ options: - Note that the datapath status is determined by the association of health monitor profiles. - 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. + type: bool created_by: description: - 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 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. + type: bool groups: description: - 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. - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool min_members: description: - The minimum number of members to distribute traffic to. @@ -124,6 +127,7 @@ options: - Field introduced in 17.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool tenant_ref: description: - It is a reference to an object of type tenant. @@ -141,6 +145,7 @@ options: - Default is true. - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool uuid: description: - Uuid of the gslb service. @@ -151,6 +156,7 @@ options: - Default is false. - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool extends_documentation_fragment: - avi ''' diff --git a/lib/ansible/modules/network/avi/avi_gslbservice_patch_member.py b/lib/ansible/modules/network/avi/avi_gslbservice_patch_member.py index d3ceaddbc1b..41a63bcdb08 100644 --- a/lib/ansible/modules/network/avi/avi_gslbservice_patch_member.py +++ b/lib/ansible/modules/network/avi/avi_gslbservice_patch_member.py @@ -112,12 +112,12 @@ from copy import deepcopy HAS_AVI = True 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.utils.ansible_utils import ( avi_obj_cmp, cleanup_absent_fields, ansible_return, AviCheckModeResponse, AviCredentials) - from ansible.module_utils.network.avi.avi import ( - avi_common_argument_spec, HAS_AVI) except ImportError: HAS_AVI = False diff --git a/lib/ansible/modules/network/avi/avi_healthmonitor.py b/lib/ansible/modules/network/avi/avi_healthmonitor.py index e05b923eb17..7b521076f38 100644 --- a/lib/ansible/modules/network/avi/avi_healthmonitor.py +++ b/lib/ansible/modules/network/avi/avi_healthmonitor.py @@ -70,6 +70,7 @@ options: - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.4" + type: bool monitor_port: description: - Use this port instead of the port defined for the server in the pool. diff --git a/lib/ansible/modules/network/avi/avi_httppolicyset.py b/lib/ansible/modules/network/avi/avi_httppolicyset.py index 49718416286..2ec38d87765 100644 --- a/lib/ansible/modules/network/avi/avi_httppolicyset.py +++ b/lib/ansible/modules/network/avi/avi_httppolicyset.py @@ -65,6 +65,7 @@ options: description: - Boolean flag to set is_internal_policy. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool name: description: - Name of the http policy set. diff --git a/lib/ansible/modules/network/avi/avi_ipamdnsproviderprofile.py b/lib/ansible/modules/network/avi/avi_ipamdnsproviderprofile.py index 95ff230c0ac..1ce046fb4b1 100644 --- a/lib/ansible/modules/network/avi/avi_ipamdnsproviderprofile.py +++ b/lib/ansible/modules/network/avi/avi_ipamdnsproviderprofile.py @@ -48,6 +48,7 @@ options: - Field introduced in 17.2.4. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool aws_profile: description: - Provider details if type is aws. diff --git a/lib/ansible/modules/network/avi/avi_network.py b/lib/ansible/modules/network/avi/avi_network.py index 405d7eabebe..9053699bcc4 100644 --- a/lib/ansible/modules/network/avi/avi_network.py +++ b/lib/ansible/modules/network/avi/avi_network.py @@ -52,10 +52,12 @@ options: description: - 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. + type: bool exclude_discovered_subnets: description: - 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. + type: bool name: description: - Name of the object. @@ -64,6 +66,7 @@ options: description: - Boolean flag to set synced_from_se. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool tenant_ref: description: - It is a reference to an object of type tenant. @@ -77,6 +80,7 @@ options: description: - Boolean flag to set vcenter_dvs. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool vimgrnw_ref: description: - It is a reference to an object of type vimgrnwruntime. diff --git a/lib/ansible/modules/network/avi/avi_pkiprofile.py b/lib/ansible/modules/network/avi/avi_pkiprofile.py index b84ad60cc4d..0bc4125de72 100644 --- a/lib/ansible/modules/network/avi/avi_pkiprofile.py +++ b/lib/ansible/modules/network/avi/avi_pkiprofile.py @@ -52,6 +52,7 @@ options: description: - 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. + type: bool crls: description: - Certificate revocation lists. @@ -60,6 +61,7 @@ options: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool is_federated: description: - This field describes the object's replication scope. @@ -68,6 +70,7 @@ options: - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.4" + type: bool name: description: - 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. - 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. + type: bool extends_documentation_fragment: - avi ''' diff --git a/lib/ansible/modules/network/avi/avi_pool.py b/lib/ansible/modules/network/avi/avi_pool.py index 4e534761052..50122f2d4ad 100644 --- a/lib/ansible/modules/network/avi/avi_pool.py +++ b/lib/ansible/modules/network/avi/avi_pool.py @@ -75,6 +75,7 @@ options: description: - Inline estimation of capacity of servers. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool capacity_estimation_ttfb_thresh: description: - The maximum time-to-first-byte of a server. @@ -116,11 +117,13 @@ options: east_west: description: - Inherited config from virtualservice. + type: bool enabled: description: - Enable or disable the pool. - 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. + type: bool external_autoscale_groups: description: - Names of external auto-scale groups for pool servers. @@ -149,6 +152,7 @@ options: - Indicates if the pool is a site-persistence pool. - Field introduced in 17.2.1. version_added: "2.5" + type: bool health_monitor_refs: description: - Verify server health by applying one or more health monitors. @@ -161,11 +165,13 @@ options: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool inline_health_monitor: description: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool ipaddrgroup_ref: description: - Use list of servers from ip address group. @@ -199,6 +205,7 @@ options: - 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. version_added: "2.5" + type: bool max_concurrent_connections_per_server: description: - The maximum number of concurrent connections allowed to each server within the pool. @@ -241,20 +248,24 @@ options: description: - Enable request queue when pool is full. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool rewrite_host_header_to_server_name: description: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool rewrite_host_header_to_sni: description: - 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. + type: bool server_auto_scale: description: - Server autoscale. - Not used anymore. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool server_count: description: - Number of server_count. @@ -275,6 +286,7 @@ options: - Enable tls sni for server connections. - 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. + type: bool ssl_key_and_certificate_ref: description: - 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. - 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. + type: bool uuid: description: - Uuid of the pool. diff --git a/lib/ansible/modules/network/avi/avi_poolgroup.py b/lib/ansible/modules/network/avi/avi_poolgroup.py index 881ca7b7bab..cbdef5d6402 100644 --- a/lib/ansible/modules/network/avi/avi_poolgroup.py +++ b/lib/ansible/modules/network/avi/avi_poolgroup.py @@ -69,6 +69,7 @@ options: - 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. version_added: "2.5" + type: bool members: description: - List of pool group members object of type poolgroupmember. diff --git a/lib/ansible/modules/network/avi/avi_poolgroupdeploymentpolicy.py b/lib/ansible/modules/network/avi/avi_poolgroupdeploymentpolicy.py index b6fd33c68ca..6f293325533 100644 --- a/lib/ansible/modules/network/avi/avi_poolgroupdeploymentpolicy.py +++ b/lib/ansible/modules/network/avi/avi_poolgroupdeploymentpolicy.py @@ -45,6 +45,7 @@ options: description: - 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. + type: bool cloud_ref: description: - It is a reference to an object of type cloud. diff --git a/lib/ansible/modules/network/avi/avi_scheduler.py b/lib/ansible/modules/network/avi/avi_scheduler.py index d78edebb279..d6888a7678f 100644 --- a/lib/ansible/modules/network/avi/avi_scheduler.py +++ b/lib/ansible/modules/network/avi/avi_scheduler.py @@ -49,6 +49,7 @@ options: description: - Boolean flag to set enabled. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool end_date_time: description: - Scheduler end date and time. diff --git a/lib/ansible/modules/network/avi/avi_serverautoscalepolicy.py b/lib/ansible/modules/network/avi/avi_serverautoscalepolicy.py index 52bb1ca9826..ca05404f063 100644 --- a/lib/ansible/modules/network/avi/avi_serverautoscalepolicy.py +++ b/lib/ansible/modules/network/avi/avi_serverautoscalepolicy.py @@ -48,6 +48,7 @@ options: description: - 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. + type: bool intelligent_scalein_margin: description: - Maximum extra capacity as percentage of load used by the intelligent scheme. @@ -110,6 +111,7 @@ options: description: - Use predicted load rather than current load. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool uuid: description: - Unique object identifier of the object. diff --git a/lib/ansible/modules/network/avi/avi_serviceengine.py b/lib/ansible/modules/network/avi/avi_serviceengine.py index 9ec8dfd3de6..242a9426a27 100644 --- a/lib/ansible/modules/network/avi/avi_serviceengine.py +++ b/lib/ansible/modules/network/avi/avi_serviceengine.py @@ -51,6 +51,7 @@ options: description: - Boolean flag to set container_mode. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool container_type: description: - Enum options - container_type_bridge, container_type_host, container_type_host_dpdk. @@ -59,6 +60,7 @@ options: description: - Boolean flag to set controller_created. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool controller_ip: description: - Controller_ip of serviceengine. diff --git a/lib/ansible/modules/network/avi/avi_serviceenginegroup.py b/lib/ansible/modules/network/avi/avi_serviceenginegroup.py index c218fec4ea8..092c5503a34 100644 --- a/lib/ansible/modules/network/avi/avi_serviceenginegroup.py +++ b/lib/ansible/modules/network/avi/avi_serviceenginegroup.py @@ -46,14 +46,17 @@ options: description: - 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. + type: bool advertise_backend_networks: description: - 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. + type: bool aggressive_failure_detection: description: - Enable aggressive failover configuration for ha. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool algo: description: - 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. - Field introduced in 17.2.5. version_added: "2.5" + type: bool archive_shm_limit: description: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.4" + type: bool async_ssl_threads: description: - 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. version_added: "2.4" 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. - 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. + type: bool auto_rebalance_capacity_per_se: description: - Capacities of se for auto rebalance for each criteria. @@ -94,7 +100,7 @@ options: auto_rebalance_criteria: description: - 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. version_added: "2.5" 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. - 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. + type: bool buffer_se: description: - Excess service engine capacity provisioned for ha failover. @@ -125,11 +132,13 @@ options: description: - Boolean flag to set cpu_reserve. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool cpu_socket_affinity: description: - Allocate all the cpu cores for the service engine virtual machines on the same cpu socket. - Applicable only for vcenter cloud. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool custom_securitygroups_data: description: - 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. - 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. + type: bool description: description: - User defined description for the object. @@ -156,20 +166,23 @@ options: - 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. version_added: "2.5" + type: bool disable_gro: description: - 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. - 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" + type: bool disable_tso: description: - Disable tcp segmentation offload (tso) in dpdk poll-mode driver packet transmit path. - Tso is on by default on nics that support it. - 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" + type: bool disk_per_se: description: - Amount of disk space for each of the service engine virtual machines. @@ -179,19 +192,23 @@ options: description: - 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. + type: bool enable_routing: description: - Enable routing for this serviceenginegroup . - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool enable_vip_on_all_interfaces: description: - Enable vip on all interfaces of se. - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool enable_vmac: description: - 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. + type: bool extra_config_multiplier: description: - Multiplier for extra config to support large vs/pool config. @@ -230,6 +247,7 @@ options: description: - 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. + type: bool host_attribute_key: description: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool hypervisor: description: - Override default hypervisor. @@ -286,6 +305,7 @@ options: description: - Select core with least load for new flow. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool license_tier: description: - Specifies the license tier which would be used. @@ -332,6 +352,7 @@ options: description: - Boolean flag to set mem_reserve. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool memory_per_se: description: - 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. - 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. + type: bool placement_mode: description: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool se_sb_threads: description: - Number of sideband threads per se. @@ -535,6 +558,7 @@ options: description: - Boolean flag to set vcenter_datastores_include. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool vcenter_folder: description: - Folder to place all the service engine virtual machines in vcenter. @@ -550,6 +574,7 @@ options: description: - 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. + type: bool vs_scalein_timeout: description: - 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. - Default value when not specified in API or module is interpreted by Avi Controller as True. version_added: "2.5" + type: bool waf_mempool_size: description: - Memory pool size used for waf. diff --git a/lib/ansible/modules/network/avi/avi_sslprofile.py b/lib/ansible/modules/network/avi/avi_sslprofile.py index ded778cea75..c687844cc86 100644 --- a/lib/ansible/modules/network/avi/avi_sslprofile.py +++ b/lib/ansible/modules/network/avi/avi_sslprofile.py @@ -68,6 +68,7 @@ options: description: - Enable ssl session re-use. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool name: description: - Name of the object. @@ -76,10 +77,12 @@ options: description: - 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. + type: bool send_close_notify: description: - 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. + type: bool ssl_rating: description: - Sslrating settings for sslprofile. diff --git a/lib/ansible/modules/network/avi/avi_systemconfiguration.py b/lib/ansible/modules/network/avi/avi_systemconfiguration.py index d9ba5693bf2..039507714ba 100644 --- a/lib/ansible/modules/network/avi/avi_systemconfiguration.py +++ b/lib/ansible/modules/network/avi/avi_systemconfiguration.py @@ -65,6 +65,7 @@ options: description: - Boolean flag to set docker_mode. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool email_configuration: description: - Emailconfiguration settings for systemconfiguration. diff --git a/lib/ansible/modules/network/avi/avi_tenant.py b/lib/ansible/modules/network/avi/avi_tenant.py index 935567a68d2..e2aa6a89b31 100644 --- a/lib/ansible/modules/network/avi/avi_tenant.py +++ b/lib/ansible/modules/network/avi/avi_tenant.py @@ -55,6 +55,7 @@ options: description: - Boolean flag to set local. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool name: description: - Name of the object. diff --git a/lib/ansible/modules/network/avi/avi_trafficcloneprofile.py b/lib/ansible/modules/network/avi/avi_trafficcloneprofile.py index 070da5cf571..fb4e8bf05c5 100644 --- a/lib/ansible/modules/network/avi/avi_trafficcloneprofile.py +++ b/lib/ansible/modules/network/avi/avi_trafficcloneprofile.py @@ -58,6 +58,7 @@ options: - Specifies if client ip needs to be preserved to clone destination. - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool tenant_ref: description: - It is a reference to an object of type tenant. diff --git a/lib/ansible/modules/network/avi/avi_virtualservice.py b/lib/ansible/modules/network/avi/avi_virtualservice.py index b31419c70d2..dad369b5666 100644 --- a/lib/ansible/modules/network/avi/avi_virtualservice.py +++ b/lib/ansible/modules/network/avi/avi_virtualservice.py @@ -68,11 +68,13 @@ options: - Auto-allocate floating/elastic ip from the cloud infrastructure. - Field deprecated in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool auto_allocate_ip: description: - Auto-allocate vip from the provided subnet. - Field deprecated in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool availability_zone: description: - Availability-zone to place the virtual service. @@ -82,11 +84,13 @@ options: - (internal-use) fip allocated by avi in the cloud infrastructure. - Field deprecated in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool avi_allocated_vip: description: - (internal-use) vip allocated by avi in the cloud infrastructure. - Field deprecated in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool client_auth: description: - Http authentication configuration for protected resources. @@ -96,6 +100,7 @@ options: - Field introduced in 17.2.4. - Default value when not specified in API or module is interpreted by Avi Controller as False. version_added: "2.5" + type: bool cloud_config_cksum: description: - Checksum of cloud configuration for vs. @@ -122,6 +127,7 @@ options: - Select the algorithm for qos fairness. - 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. + type: bool description: description: - User defined description for the object. @@ -154,20 +160,25 @@ options: description: - 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. + type: bool enable_autogw: 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. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool enable_rhi: description: - Enable route health injection using the bgp config in the vrf context. + type: bool enable_rhi_snat: description: - Enable route health injection for source nat'ted floating ip address using the bgp config in the vrf context. + type: bool enabled: description: - Enable or disable the virtual service. - Default value when not specified in API or module is interpreted by Avi Controller as True. + type: bool error_page_profile_ref: 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. @@ -209,6 +220,7 @@ options: description: - 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. + type: bool ip_address: description: - Ip address of the virtual service. @@ -221,6 +233,7 @@ options: description: - 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. + type: bool max_cps_per_client: description: - Maximum connections per second per client ip. @@ -272,6 +285,7 @@ options: description: - Remove listening port if virtualservice is down. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool requests_rate_limit: description: - 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. - 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. + type: bool se_group_ref: description: - The service engine group to use for this virtual service. @@ -364,6 +379,7 @@ options: description: - 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. + type: bool use_vip_as_snat: 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. @@ -372,6 +388,7 @@ options: - 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. version_added: "2.5" + type: bool uuid: description: - Uuid of the virtualservice. @@ -398,7 +415,7 @@ options: - Datascripts applied on the data traffic of the virtual service. vsvip_ref: 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. - Field introduced in 17.1.1. version_added: "2.4" diff --git a/lib/ansible/modules/network/avi/avi_vrfcontext.py b/lib/ansible/modules/network/avi/avi_vrfcontext.py index b48bc327b5f..14e09957666 100644 --- a/lib/ansible/modules/network/avi/avi_vrfcontext.py +++ b/lib/ansible/modules/network/avi/avi_vrfcontext.py @@ -73,6 +73,7 @@ options: description: - Boolean flag to set system_default. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool tenant_ref: description: - It is a reference to an object of type tenant. diff --git a/lib/ansible/modules/network/avi/avi_vsvip.py b/lib/ansible/modules/network/avi/avi_vsvip.py index 03603db786a..bce260bd7a4 100644 --- a/lib/ansible/modules/network/avi/avi_vsvip.py +++ b/lib/ansible/modules/network/avi/avi_vsvip.py @@ -55,6 +55,7 @@ options: - Force placement on all service engines in the service engine group (container clouds only). - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. + type: bool name: description: - Name for the vsvip object. diff --git a/lib/ansible/modules/network/avi/avi_wafpolicy.py b/lib/ansible/modules/network/avi/avi_wafpolicy.py index d1bdd8a1770..d97fdd6c37b 100644 --- a/lib/ansible/modules/network/avi/avi_wafpolicy.py +++ b/lib/ansible/modules/network/avi/avi_wafpolicy.py @@ -60,6 +60,7 @@ options: - Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. - 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. + required: true name: description: - Field introduced in 17.2.1. @@ -96,6 +97,7 @@ options: - Waf profile for waf policy. - It is a reference to an object of type wafprofile. - Field introduced in 17.2.1. + required: true extends_documentation_fragment: - avi ''' @@ -135,7 +137,7 @@ def main(): created_by=dict(type='str',), crs_groups=dict(type='list',), description=dict(type='str',), - mode=dict(type='str',), + mode=dict(type='str', required=True), name=dict(type='str', required=True), paranoia_level=dict(type='str',), post_crs_groups=dict(type='list',), @@ -143,7 +145,7 @@ def main(): tenant_ref=dict(type='str',), url=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()) module = AnsibleModule( diff --git a/lib/ansible/utils/module_docs_fragments/avi.py b/lib/ansible/utils/module_docs_fragments/avi.py index fc397445520..5e034fe540a 100644 --- a/lib/ansible/utils/module_docs_fragments/avi.py +++ b/lib/ansible/utils/module_docs_fragments/avi.py @@ -28,12 +28,15 @@ options: controller: description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). + default: '' username: description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). + default: '' password: description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). + default: '' tenant: description: - Name of tenant used for all Avi API calls and context of object. @@ -45,6 +48,7 @@ options: api_version: description: - Avi API version of to use for Avi API and objects. + default: "16.4.4" avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. diff --git a/test/sanity/validate-modules/ignore.txt b/test/sanity/validate-modules/ignore.txt index ff77b806090..fbb93387edc 100644 --- a/test/sanity/validate-modules/ignore.txt +++ b/test/sanity/validate-modules/ignore.txt @@ -1270,102 +1270,6 @@ lib/ansible/modules/network/asa/asa_command.py E325 lib/ansible/modules/network/asa/asa_command.py E326 lib/ansible/modules/network/asa/asa_config.py E325 lib/ansible/modules/network/asa/asa_config.py E326 -lib/ansible/modules/network/avi/avi_actiongroupconfig.py E324 -lib/ansible/modules/network/avi/avi_actiongroupconfig.py E325 -lib/ansible/modules/network/avi/avi_alertconfig.py E324 -lib/ansible/modules/network/avi/avi_alertconfig.py E325 -lib/ansible/modules/network/avi/avi_alertemailconfig.py E324 -lib/ansible/modules/network/avi/avi_alertscriptconfig.py E324 -lib/ansible/modules/network/avi/avi_alertsyslogconfig.py E324 -lib/ansible/modules/network/avi/avi_analyticsprofile.py E324 -lib/ansible/modules/network/avi/avi_analyticsprofile.py E325 -lib/ansible/modules/network/avi/avi_api_session.py E324 -lib/ansible/modules/network/avi/avi_api_version.py E324 -lib/ansible/modules/network/avi/avi_applicationpersistenceprofile.py E324 -lib/ansible/modules/network/avi/avi_applicationpersistenceprofile.py E325 -lib/ansible/modules/network/avi/avi_applicationprofile.py E324 -lib/ansible/modules/network/avi/avi_applicationprofile.py E325 -lib/ansible/modules/network/avi/avi_authprofile.py E324 -lib/ansible/modules/network/avi/avi_backup.py E324 -lib/ansible/modules/network/avi/avi_backupconfiguration.py E324 -lib/ansible/modules/network/avi/avi_backupconfiguration.py E325 -lib/ansible/modules/network/avi/avi_certificatemanagementprofile.py E324 -lib/ansible/modules/network/avi/avi_cloud.py E324 -lib/ansible/modules/network/avi/avi_cloud.py E325 -lib/ansible/modules/network/avi/avi_cloudconnectoruser.py E324 -lib/ansible/modules/network/avi/avi_cloudproperties.py E324 -lib/ansible/modules/network/avi/avi_cluster.py E324 -lib/ansible/modules/network/avi/avi_cluster.py E325 -lib/ansible/modules/network/avi/avi_clusterclouddetails.py E324 -lib/ansible/modules/network/avi/avi_controllerproperties.py E324 -lib/ansible/modules/network/avi/avi_controllerproperties.py E325 -lib/ansible/modules/network/avi/avi_customipamdnsprofile.py E324 -lib/ansible/modules/network/avi/avi_dnspolicy.py E324 -lib/ansible/modules/network/avi/avi_errorpagebody.py E324 -lib/ansible/modules/network/avi/avi_errorpageprofile.py E324 -lib/ansible/modules/network/avi/avi_gslb.py E324 -lib/ansible/modules/network/avi/avi_gslb.py E325 -lib/ansible/modules/network/avi/avi_gslbapplicationpersistenceprofile.py E324 -lib/ansible/modules/network/avi/avi_gslbgeodbprofile.py E324 -lib/ansible/modules/network/avi/avi_gslbgeodbprofile.py E325 -lib/ansible/modules/network/avi/avi_gslbhealthmonitor.py E324 -lib/ansible/modules/network/avi/avi_gslbservice.py E324 -lib/ansible/modules/network/avi/avi_gslbservice.py E325 -lib/ansible/modules/network/avi/avi_gslbservice_patch_member.py E324 -lib/ansible/modules/network/avi/avi_hardwaresecuritymodulegroup.py E324 -lib/ansible/modules/network/avi/avi_healthmonitor.py E324 -lib/ansible/modules/network/avi/avi_healthmonitor.py E325 -lib/ansible/modules/network/avi/avi_httppolicyset.py E324 -lib/ansible/modules/network/avi/avi_httppolicyset.py E325 -lib/ansible/modules/network/avi/avi_ipaddrgroup.py E324 -lib/ansible/modules/network/avi/avi_ipamdnsproviderprofile.py E324 -lib/ansible/modules/network/avi/avi_ipamdnsproviderprofile.py E325 -lib/ansible/modules/network/avi/avi_microservicegroup.py E324 -lib/ansible/modules/network/avi/avi_network.py E324 -lib/ansible/modules/network/avi/avi_network.py E325 -lib/ansible/modules/network/avi/avi_networkprofile.py E324 -lib/ansible/modules/network/avi/avi_networksecuritypolicy.py E324 -lib/ansible/modules/network/avi/avi_pkiprofile.py E324 -lib/ansible/modules/network/avi/avi_pkiprofile.py E325 -lib/ansible/modules/network/avi/avi_pool.py E324 -lib/ansible/modules/network/avi/avi_pool.py E325 -lib/ansible/modules/network/avi/avi_poolgroup.py E324 -lib/ansible/modules/network/avi/avi_poolgroup.py E325 -lib/ansible/modules/network/avi/avi_poolgroupdeploymentpolicy.py E324 -lib/ansible/modules/network/avi/avi_poolgroupdeploymentpolicy.py E325 -lib/ansible/modules/network/avi/avi_prioritylabels.py E324 -lib/ansible/modules/network/avi/avi_role.py E324 -lib/ansible/modules/network/avi/avi_scheduler.py E324 -lib/ansible/modules/network/avi/avi_scheduler.py E325 -lib/ansible/modules/network/avi/avi_seproperties.py E324 -lib/ansible/modules/network/avi/avi_serverautoscalepolicy.py E324 -lib/ansible/modules/network/avi/avi_serverautoscalepolicy.py E325 -lib/ansible/modules/network/avi/avi_serviceengine.py E324 -lib/ansible/modules/network/avi/avi_serviceengine.py E325 -lib/ansible/modules/network/avi/avi_serviceenginegroup.py E324 -lib/ansible/modules/network/avi/avi_serviceenginegroup.py E325 -lib/ansible/modules/network/avi/avi_snmptrapprofile.py E324 -lib/ansible/modules/network/avi/avi_sslkeyandcertificate.py E324 -lib/ansible/modules/network/avi/avi_sslprofile.py E324 -lib/ansible/modules/network/avi/avi_sslprofile.py E325 -lib/ansible/modules/network/avi/avi_stringgroup.py E324 -lib/ansible/modules/network/avi/avi_systemconfiguration.py E324 -lib/ansible/modules/network/avi/avi_systemconfiguration.py E325 -lib/ansible/modules/network/avi/avi_tenant.py E324 -lib/ansible/modules/network/avi/avi_tenant.py E325 -lib/ansible/modules/network/avi/avi_trafficcloneprofile.py E324 -lib/ansible/modules/network/avi/avi_trafficcloneprofile.py E325 -lib/ansible/modules/network/avi/avi_useraccountprofile.py E324 -lib/ansible/modules/network/avi/avi_virtualservice.py E324 -lib/ansible/modules/network/avi/avi_virtualservice.py E325 -lib/ansible/modules/network/avi/avi_vrfcontext.py E324 -lib/ansible/modules/network/avi/avi_vrfcontext.py E325 -lib/ansible/modules/network/avi/avi_vsdatascriptset.py E324 -lib/ansible/modules/network/avi/avi_vsvip.py E324 -lib/ansible/modules/network/avi/avi_vsvip.py E325 -lib/ansible/modules/network/avi/avi_wafpolicy.py E324 -lib/ansible/modules/network/avi/avi_wafprofile.py E324 -lib/ansible/modules/network/avi/avi_webhook.py E324 lib/ansible/modules/network/bigswitch/bcf_switch.py E325 lib/ansible/modules/network/bigswitch/bcf_switch.py E326 lib/ansible/modules/network/bigswitch/bigmon_chain.py E325