Class: Ansible::Ruby::Modules::Avi_cloud

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb

Overview

This module is used to configure Cloud object more examples at U(github.com/avinetworks/devops)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#apic_configuration ⇒ Object?

Returns Apicconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Apicconfiguration settings for cloud.



25
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 25

attribute :apic_configuration

#apic_mode ⇒ Symbol?

Returns Boolean flag to set apic_mode.,Default value when not specified in API or module is interpreted by Avi Controller as False.

Returns:

  • (Symbol, nil) —

    Boolean flag to set apic_mode.,Default value when not specified in API or module is interpreted by Avi Controller as False.



28
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 28

attribute :apic_mode

#avi_api_patch_op ⇒ :add, ...

Returns Patch operation to use when using avi_api_update_method as patch.

Returns:

  • (:add, :replace, :delete, nil) —

    Patch operation to use when using avi_api_update_method as patch.



21
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 21

attribute :avi_api_patch_op

#avi_api_update_method ⇒ :put, ...

Returns Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.

Returns:

  • (:put, :patch, nil) —

    Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.



17
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 17

attribute :avi_api_update_method

#aws_configuration ⇒ Object?

Returns Awsconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Awsconfiguration settings for cloud.



32
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 32

attribute :aws_configuration

#azure_configuration ⇒ Object?

Returns Field introduced in 17.2.1.

Returns:

  • (Object, nil) —

    Field introduced in 17.2.1.



35
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 35

attribute :azure_configuration

#cloudstack_configuration ⇒ Object?

Returns Cloudstackconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Cloudstackconfiguration settings for cloud.



38
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 38

attribute :cloudstack_configuration

#custom_tags ⇒ Object?

Returns Custom tags for all avi created resources in the cloud infrastructure.,Field introduced in 17.1.5.

Returns:

  • (Object, nil) —

    Custom tags for all avi created resources in the cloud infrastructure.,Field introduced in 17.1.5.



41
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 41

attribute :custom_tags

#dhcp_enabled ⇒ Symbol?

Returns Select the ip address management scheme.,Default value when not specified in API or module is interpreted by Avi Controller as False.

Returns:

  • (Symbol, nil) —

    Select the ip address management scheme.,Default value when not specified in API or module is interpreted by Avi Controller as False.



44
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 44

attribute :dhcp_enabled

#dns_provider_ref ⇒ Object?

Returns Dns profile for the cloud.,It is a reference to an object of type ipamdnsproviderprofile.

Returns:

  • (Object, nil) —

    Dns profile for the cloud.,It is a reference to an object of type ipamdnsproviderprofile.



48
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 48

attribute :dns_provider_ref

#docker_configuration ⇒ Object?

Returns Dockerconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Dockerconfiguration settings for cloud.



51
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 51

attribute :docker_configuration

#east_west_dns_provider_ref ⇒ Object?

Returns Dns profile for east-west services.,It is a reference to an object of type ipamdnsproviderprofile.

Returns:

  • (Object, nil) —

    Dns profile for east-west services.,It is a reference to an object of type ipamdnsproviderprofile.



54
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 54

attribute :east_west_dns_provider_ref

#east_west_ipam_provider_ref ⇒ Object?

Returns Ipam profile for east-west services.,Warning - please use virtual subnets in this ipam profile that do not conflict with the underlay networks or any overlay networks in the cluster.,For example in aws and gcp, 169.254.0.0/16 is used for storing instance metadata.,Hence, it should not be used in this profile.,It is a reference to an object of type ipamdnsproviderprofile.

Returns:

  • (Object, nil) —

    Ipam profile for east-west services.,Warning - please use virtual subnets in this ipam profile that do not conflict with the underlay networks or any overlay networks in the cluster.,For example in aws and gcp, 169.254.0.0/16 is used for storing instance metadata.,Hence, it should not be used in this profile.,It is a reference to an object of type ipamdnsproviderprofile.



57
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 57

attribute :east_west_ipam_provider_ref

#enable_vip_static_routes ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



60
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 60

attribute :enable_vip_static_routes

#ipam_provider_ref ⇒ Object?

Returns Ipam profile for the cloud.,It is a reference to an object of type ipamdnsproviderprofile.

Returns:

  • (Object, nil) —

    Ipam profile for the cloud.,It is a reference to an object of type ipamdnsproviderprofile.



64
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 64

attribute :ipam_provider_ref

#license_tier ⇒ Object?

Returns Specifies the default license tier which would be used by new se groups.,This field by default inherits the value from system configuration.,Enum options - ENTERPRISE_16, ENTERPRISE_18.,Field introduced in 17.2.5.

Returns:

  • (Object, nil) —

    Specifies the default license tier which would be used by new se groups.,This field by default inherits the value from system configuration.,Enum options - ENTERPRISE_16, ENTERPRISE_18.,Field introduced in 17.2.5.



67
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 67

attribute :license_tier

#license_type ⇒ String?

Returns If no license type is specified then default license enforcement for the cloud type is chosen.,The default mappings are container cloud is max ses, openstack and vmware is cores and linux it is sockets.,Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH.

Returns:

  • (String, nil) —

    If no license type is specified then default license enforcement for the cloud type is chosen.,The default mappings are container cloud is max ses, openstack and vmware is cores and linux it is sockets.,Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH.



70
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 70

attribute :license_type

#linuxserver_configuration ⇒ Object?

Returns Linuxserverconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Linuxserverconfiguration settings for cloud.



74
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 74

attribute :linuxserver_configuration

#mesos_configuration ⇒ Object?

Returns Mesosconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Mesosconfiguration settings for cloud.



77
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 77

attribute :mesos_configuration

#mtu ⇒ Integer?

Returns Mtu setting for the cloud.,Default value when not specified in API or module is interpreted by Avi Controller as 1500.,Units(BYTES).

Returns:

  • (Integer, nil) —

    Mtu setting for the cloud.,Default value when not specified in API or module is interpreted by Avi Controller as 1500.,Units(BYTES).



80
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 80

attribute :mtu

#name ⇒ String

Returns Name of the object.

Returns:

  • (String) —

    Name of the object.



84
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 84

attribute :name

#nsx_configuration ⇒ Object?

Returns Configuration parameters for nsx manager.,Field introduced in 17.1.1.

Returns:

  • (Object, nil) —

    Configuration parameters for nsx manager.,Field introduced in 17.1.1.



88
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 88

attribute :nsx_configuration

#obj_name_prefix ⇒ Object?

Returns Default prefix for all automatically created objects in this cloud.,This prefix can be overridden by the se-group template.

Returns:

  • (Object, nil) —

    Default prefix for all automatically created objects in this cloud.,This prefix can be overridden by the se-group template.



91
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 91

attribute :obj_name_prefix

#openstack_configuration ⇒ Object?

Returns Openstackconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Openstackconfiguration settings for cloud.



94
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 94

attribute :openstack_configuration

#oshiftk8s_configuration ⇒ Object?

Returns Oshiftk8sconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Oshiftk8sconfiguration settings for cloud.



97
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 97

attribute :oshiftk8s_configuration

#prefer_static_routes ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



100
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 100

attribute :prefer_static_routes

#proxy_configuration ⇒ Object?

Returns Proxyconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Proxyconfiguration settings for cloud.



104
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 104

attribute :proxy_configuration

#rancher_configuration ⇒ Object?

Returns Rancherconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Rancherconfiguration settings for cloud.



107
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 107

attribute :rancher_configuration

#state ⇒ :absent, ...

Returns The state that should be applied on the entity.

Returns:

  • (:absent, :present, nil) —

    The state that should be applied on the entity.



13
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 13

attribute :state

#state_based_dns_registration ⇒ Symbol?

Returns Dns records for vips are added/deleted based on the operational state of the vips.,Field introduced in 17.1.12.,Default value when not specified in API or module is interpreted by Avi Controller as True.

Returns:

  • (Symbol, nil) —

    Dns records for vips are added/deleted based on the operational state of the vips.,Field introduced in 17.1.12.,Default value when not specified in API or module is interpreted by Avi Controller as True.



110
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 110

attribute :state_based_dns_registration

#tenant_ref ⇒ String?

Returns It is a reference to an object of type tenant.

Returns:

  • (String, nil) —

    It is a reference to an object of type tenant.



114
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 114

attribute :tenant_ref

#url ⇒ Object?

Returns Avi controller URL of the object.

Returns:

  • (Object, nil) —

    Avi controller URL of the object.



118
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 118

attribute :url

#uuid ⇒ Object?

Returns Unique object identifier of the object.

Returns:

  • (Object, nil) —

    Unique object identifier of the object.



121
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 121

attribute :uuid

#vca_configuration ⇒ Object?

Returns Vcloudairconfiguration settings for cloud.

Returns:

  • (Object, nil) —

    Vcloudairconfiguration settings for cloud.



124
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 124

attribute :vca_configuration

#vcenter_configuration ⇒ Hash?

Returns Vcenterconfiguration settings for cloud.

Returns:

  • (Hash, nil) —

    Vcenterconfiguration settings for cloud.



127
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 127

attribute :vcenter_configuration

#vtype ⇒ String

Returns Cloud type.,Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP,,CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE.,Default value when not specified in API or module is interpreted by Avi Controller as CLOUD_NONE.

Returns:

  • (String) —

    Cloud type.,Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP,,CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE.,Default value when not specified in API or module is interpreted by Avi Controller as CLOUD_NONE.



131
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_cloud.rb', line 131

attribute :vtype