Class: Ansible::Ruby::Modules::Avi_virtualservice

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

Overview

This module is used to configure VirtualService 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

#active_standby_se_tag ⇒ Object?

Returns This configuration only applies if the virtualservice is in legacy active standby ha mode and load distribution among active standby is enabled.,This field is used to tag the virtualservice so that virtualservices with the same tag will share the same active serviceengine.,Virtualservices with different tags will have different active serviceengines.,If one of the serviceengine’s in the serviceenginegroup fails, all virtualservices will end up using the same active serviceengine.,Redistribution of the virtualservices can be either manual or automated when the failed serviceengine recovers.,Redistribution is based on the auto redistribute property of the serviceenginegroup.,Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2.,Default value when not specified in API or module is interpreted by Avi Controller as ACTIVE_STANDBY_SE_1.

Returns:

  • (Object, nil) —

    This configuration only applies if the virtualservice is in legacy active standby ha mode and load distribution among active standby is enabled.,This field is used to tag the virtualservice so that virtualservices with the same tag will share the same active serviceengine.,Virtualservices with different tags will have different active serviceengines.,If one of the serviceengine’s in the serviceenginegroup fails, all virtualservices will end up using the same active serviceengine.,Redistribution of the virtualservices can be either manual or automated when the failed serviceengine recovers.,Redistribution is based on the auto redistribute property of the serviceenginegroup.,Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2.,Default value when not specified in API or module is interpreted by Avi Controller as ACTIVE_STANDBY_SE_1.



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

attribute :active_standby_se_tag

#analytics_policy ⇒ Object?

Returns Determines analytics settings for the application.

Returns:

  • (Object, nil) —

    Determines analytics settings for the application.



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

attribute :analytics_policy

#analytics_profile_ref ⇒ Object?

Returns Specifies settings related to analytics.,It is a reference to an object of type analyticsprofile.

Returns:

  • (Object, nil) —

    Specifies settings related to analytics.,It is a reference to an object of type analyticsprofile.



31
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 31

attribute :analytics_profile_ref

#application_profile_ref ⇒ String?

Returns Enable application layer specific features for the virtual service.,It is a reference to an object of type applicationprofile.

Returns:

  • (String, nil) —

    Enable application layer specific features for the virtual service.,It is a reference to an object of type applicationprofile.



34
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 34

attribute :application_profile_ref

#auto_allocate_floating_ip ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



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

attribute :auto_allocate_floating_ip

#auto_allocate_ip ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



42
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 42

attribute :auto_allocate_ip

#availability_zone ⇒ Object?

Returns Availability-zone to place the virtual service.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    Availability-zone to place the virtual service.,Field deprecated in 17.1.1.



46
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 46

attribute :availability_zone

#avi_allocated_fip ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



49
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 49

attribute :avi_allocated_fip

#avi_allocated_vip ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



53
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 53

attribute :avi_allocated_vip

#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_virtualservice.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_virtualservice.rb', line 17

attribute :avi_api_update_method

#bulk_sync_kvcache ⇒ Symbol?

Returns (this is a beta feature).,Sync key-value cache to the new ses when vs is scaled out.,For ex ssl sessions are stored using vs’s key-value cache.,When the vs is scaled out, the ssl session information is synced to the new se, allowing existing ssl sessions to be reused on the new se.,Field introduced in 17.2.7, 18.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False.

Returns:

  • (Symbol, nil) —

    (this is a beta feature).,Sync key-value cache to the new ses when vs is scaled out.,For ex ssl sessions are stored using vs’s key-value cache.,When the vs is scaled out, the ssl session information is synced to the new se, allowing existing ssl sessions to be reused on the new se.,Field introduced in 17.2.7, 18.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False.



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

attribute :bulk_sync_kvcache

#client_auth ⇒ Object?

Returns Http authentication configuration for protected resources.

Returns:

  • (Object, nil) —

    Http authentication configuration for protected resources.



61
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 61

attribute :client_auth

#close_client_conn_on_config_update ⇒ Symbol?

Returns Close client connection on vs config update.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as False.

Returns:

  • (Symbol, nil) —

    Close client connection on vs config update.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as False.



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

attribute :close_client_conn_on_config_update

#cloud_config_cksum ⇒ Object?

Returns Checksum of cloud configuration for vs.,Internally set by cloud connector.

Returns:

  • (Object, nil) —

    Checksum of cloud configuration for vs.,Internally set by cloud connector.



68
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 68

attribute :cloud_config_cksum

#cloud_ref ⇒ Object?

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

Returns:

  • (Object, nil) —

    It is a reference to an object of type cloud.



71
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 71

attribute :cloud_ref

#cloud_type ⇒ Object?

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

  • (Object, nil) —

    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.



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

attribute :cloud_type

#connections_rate_limit ⇒ Object?

Returns Rate limit the incoming connections to this virtual service.

Returns:

  • (Object, nil) —

    Rate limit the incoming connections to this virtual service.



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

attribute :connections_rate_limit

#content_rewrite ⇒ Object?

Returns Profile used to match and rewrite strings in request and/or response body.

Returns:

  • (Object, nil) —

    Profile used to match and rewrite strings in request and/or response body.



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

attribute :content_rewrite

#created_by ⇒ Object?

Returns Creator name.

Returns:

  • (Object, nil) —

    Creator name.



83
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 83

attribute :created_by

#delay_fairness ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



86
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 86

attribute :delay_fairness

#description ⇒ Object?

Returns User defined description for the object.

Returns:

  • (Object, nil) —

    User defined description for the object.



90
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 90

attribute :description

#discovered_network_ref ⇒ Object?

Returns (internal-use) discovered networks providing reachability for client facing virtual service ip.,This field is deprecated.,It is a reference to an object of type network.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    (internal-use) discovered networks providing reachability for client facing virtual service ip.,This field is deprecated.,It is a reference to an object of type network.,Field deprecated in 17.1.1.



93
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 93

attribute :discovered_network_ref

#discovered_networks ⇒ Object?

Returns (internal-use) discovered networks providing reachability for client facing virtual service ip.,This field is used internally by avi, not editable by the user.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    (internal-use) discovered networks providing reachability for client facing virtual service ip.,This field is used internally by avi, not editable by the user.,Field deprecated in 17.1.1.



96
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 96

attribute :discovered_networks

#discovered_subnet ⇒ Object?

Returns (internal-use) discovered subnets providing reachability for client facing virtual service ip.,This field is deprecated.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    (internal-use) discovered subnets providing reachability for client facing virtual service ip.,This field is deprecated.,Field deprecated in 17.1.1.



99
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 99

attribute :discovered_subnet

#dns_info ⇒ Object?

Returns Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record.,Note that only one of fqdn and dns_info setting is allowed.

Returns:

  • (Object, nil) —

    Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record.,Note that only one of fqdn and dns_info setting is allowed.



102
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 102

attribute :dns_info

#dns_policies ⇒ Object?

Returns Dns policies applied on the dns traffic of the virtual service.,Field introduced in 17.1.1.

Returns:

  • (Object, nil) —

    Dns policies applied on the dns traffic of the virtual service.,Field introduced in 17.1.1.



105
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 105

attribute :dns_policies

#east_west_placement ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



108
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 108

attribute :east_west_placement

#enable_autogw ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



112
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 112

attribute :enable_autogw

#enable_rhi ⇒ Symbol?

Returns Enable route health injection using the bgp config in the vrf context.

Returns:

  • (Symbol, nil) —

    Enable route health injection using the bgp config in the vrf context.



116
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 116

attribute :enable_rhi

#enable_rhi_snat ⇒ Symbol?

Returns Enable route health injection for source nat’ted floating ip address using the bgp config in the vrf context.

Returns:

  • (Symbol, nil) —

    Enable route health injection for source nat’ted floating ip address using the bgp config in the vrf context.



120
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 120

attribute :enable_rhi_snat

#enabled ⇒ Symbol?

Returns Enable or disable the virtual service.,Default value when not specified in API or module is interpreted by Avi Controller as True.

Returns:

  • (Symbol, nil) —

    Enable or disable the virtual service.,Default value when not specified in API or module is interpreted by Avi Controller as True.



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

attribute :enabled

#error_page_profile_ref ⇒ Object?

Returns 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.,It is a reference to an object of type errorpageprofile.,Field introduced in 17.2.4.

Returns:

  • (Object, nil) —

    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.,It is a reference to an object of type errorpageprofile.,Field introduced in 17.2.4.



128
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 128

attribute :error_page_profile_ref

#floating_ip ⇒ Object?

Returns Floating ip to associate with this virtual service.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    Floating ip to associate with this virtual service.,Field deprecated in 17.1.1.



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

attribute :floating_ip

#floating_subnet_uuid ⇒ Object?

Returns If auto_allocate_floating_ip is true and more than one floating-ip subnets exist, then the subnet for the floating ip address allocation.,This field is applicable only if the virtualservice belongs to an openstack or aws cloud.,In openstack or aws cloud it is required when auto_allocate_floating_ip is selected.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    If auto_allocate_floating_ip is true and more than one floating-ip subnets exist, then the subnet for the floating ip address allocation.,This field is applicable only if the virtualservice belongs to an openstack or aws cloud.,In openstack or aws cloud it is required when auto_allocate_floating_ip is selected.,Field deprecated in 17.1.1.



134
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 134

attribute :floating_subnet_uuid

#flow_dist ⇒ Object?

Returns Criteria for flow distribution among ses.,Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT.,Default value when not specified in API or module is interpreted by Avi Controller as LOAD_AWARE.

Returns:

  • (Object, nil) —

    Criteria for flow distribution among ses.,Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT.,Default value when not specified in API or module is interpreted by Avi Controller as LOAD_AWARE.



137
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 137

attribute :flow_dist

#flow_label_type ⇒ Object?

Returns Criteria for flow labelling.,Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL.,Default value when not specified in API or module is interpreted by Avi Controller as NO_LABEL.

Returns:

  • (Object, nil) —

    Criteria for flow labelling.,Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL.,Default value when not specified in API or module is interpreted by Avi Controller as NO_LABEL.



140
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 140

attribute :flow_label_type

#fqdn ⇒ Object?

Returns Dns resolvable, fully qualified domain name of the virtualservice.,Only one of ‘fqdn’ and ‘dns_info’ configuration is allowed.

Returns:

  • (Object, nil) —

    Dns resolvable, fully qualified domain name of the virtualservice.,Only one of ‘fqdn’ and ‘dns_info’ configuration is allowed.



143
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 143

attribute :fqdn

#host_name_xlate ⇒ Object?

Returns Translate the host name sent to the servers to this value.,Translate the host name sent from servers back to the value used by the client.

Returns:

  • (Object, nil) —

    Translate the host name sent to the servers to this value.,Translate the host name sent from servers back to the value used by the client.



146
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 146

attribute :host_name_xlate

#http_policies ⇒ Object?

Returns Http policies applied on the data traffic of the virtual service.

Returns:

  • (Object, nil) —

    Http policies applied on the data traffic of the virtual service.



149
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 149

attribute :http_policies

#ign_pool_net_reach ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



152
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 152

attribute :ign_pool_net_reach

#ip_address ⇒ NilClass?

Returns Ip address of the virtual service.,Field deprecated in 17.1.1.

Returns:

  • (NilClass, nil) —

    Ip address of the virtual service.,Field deprecated in 17.1.1.



156
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 156

attribute :ip_address

#ipam_network_subnet ⇒ Object?

Returns Subnet and/or network for allocating virtualservice ip by ipam provider module.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    Subnet and/or network for allocating virtualservice ip by ipam provider module.,Field deprecated in 17.1.1.



160
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 160

attribute :ipam_network_subnet

#l4_policies ⇒ Object?

Returns L4 policies applied to the data traffic of the virtual service.,Field introduced in 17.2.7.

Returns:

  • (Object, nil) —

    L4 policies applied to the data traffic of the virtual service.,Field introduced in 17.2.7.



163
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 163

attribute :l4_policies

#limit_doser ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



166
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 166

attribute :limit_doser

#max_cps_per_client ⇒ Object?

Returns Maximum connections per second per client ip.,Allowed values are 10-1000.,Special values are 0- ‘unlimited’.,Default value when not specified in API or module is interpreted by Avi Controller as 0.

Returns:

  • (Object, nil) —

    Maximum connections per second per client ip.,Allowed values are 10-1000.,Special values are 0- ‘unlimited’.,Default value when not specified in API or module is interpreted by Avi Controller as 0.



170
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 170

attribute :max_cps_per_client

#microservice_ref ⇒ Object?

Returns Microservice representing the virtual service.,It is a reference to an object of type microservice.

Returns:

  • (Object, nil) —

    Microservice representing the virtual service.,It is a reference to an object of type microservice.



173
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 173

attribute :microservice_ref

#name ⇒ String

Returns Name for the virtual service.

Returns:

  • (String) —

    Name for the virtual service.



176
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 176

attribute :name

#network_profile_ref ⇒ Object?

Returns Determines network settings such as protocol, tcp or udp, and related options for the protocol.,It is a reference to an object of type networkprofile.

Returns:

  • (Object, nil) —

    Determines network settings such as protocol, tcp or udp, and related options for the protocol.,It is a reference to an object of type networkprofile.



180
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 180

attribute :network_profile_ref

#network_ref ⇒ Object?

Returns Manually override the network on which the virtual service is placed.,It is a reference to an object of type network.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    Manually override the network on which the virtual service is placed.,It is a reference to an object of type network.,Field deprecated in 17.1.1.



183
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 183

attribute :network_ref

#network_security_policy_ref ⇒ Object?

Returns Network security policies for the virtual service.,It is a reference to an object of type networksecuritypolicy.

Returns:

  • (Object, nil) —

    Network security policies for the virtual service.,It is a reference to an object of type networksecuritypolicy.



186
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 186

attribute :network_security_policy_ref

#nsx_securitygroup ⇒ Object?

Returns A list of nsx service groups representing the clients which can access the virtual ip of the virtual service.,Field introduced in 17.1.1.

Returns:

  • (Object, nil) —

    A list of nsx service groups representing the clients which can access the virtual ip of the virtual service.,Field introduced in 17.1.1.



189
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 189

attribute :nsx_securitygroup

#performance_limits ⇒ NilClass?

Returns Optional settings that determine performance limits like max connections or bandwdith etc.

Returns:

  • (NilClass, nil) —

    Optional settings that determine performance limits like max connections or bandwdith etc.



192
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 192

attribute :performance_limits

#pool_group_ref ⇒ Object?

Returns The pool group is an object that contains pools.,It is a reference to an object of type poolgroup.

Returns:

  • (Object, nil) —

    The pool group is an object that contains pools.,It is a reference to an object of type poolgroup.



196
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 196

attribute :pool_group_ref

#pool_ref ⇒ String?

Returns The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.,It is a reference to an object of type pool.

Returns:

  • (String, nil) —

    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.,It is a reference to an object of type pool.



199
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 199

attribute :pool_ref

#port_uuid ⇒ Object?

Returns (internal-use) network port assigned to the virtual service ip address.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    (internal-use) network port assigned to the virtual service ip address.,Field deprecated in 17.1.1.



203
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 203

attribute :port_uuid

#remove_listening_port_on_vs_down ⇒ Symbol?

Returns Remove listening port if virtualservice is down.,Default value when not specified in API or module is interpreted by Avi Controller as False.

Returns:

  • (Symbol, nil) —

    Remove listening port if virtualservice is down.,Default value when not specified in API or module is interpreted by Avi Controller as False.



206
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 206

attribute :remove_listening_port_on_vs_down

#requests_rate_limit ⇒ Object?

Returns Rate limit the incoming requests to this virtual service.

Returns:

  • (Object, nil) —

    Rate limit the incoming requests to this virtual service.



210
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 210

attribute :requests_rate_limit

#scaleout_ecmp ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



213
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 213

attribute :scaleout_ecmp

#se_group_ref ⇒ Object?

Returns The service engine group to use for this virtual service.,Moving to a new se group is disruptive to existing connections for this vs.,It is a reference to an object of type serviceenginegroup.

Returns:

  • (Object, nil) —

    The service engine group to use for this virtual service.,Moving to a new se group is disruptive to existing connections for this vs.,It is a reference to an object of type serviceenginegroup.



217
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 217

attribute :se_group_ref

#server_network_profile_ref ⇒ Object?

Returns Determines the network settings profile for the server side of tcp proxied connections.,Leave blank to use the same settings as the client to vs side of the connection.,It is a reference to an object of type networkprofile.

Returns:

  • (Object, nil) —

    Determines the network settings profile for the server side of tcp proxied connections.,Leave blank to use the same settings as the client to vs side of the connection.,It is a reference to an object of type networkprofile.



220
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 220

attribute :server_network_profile_ref

#service_metadata ⇒ Object?

Returns Metadata pertaining to the service provided by this virtual service.,In openshift/kubernetes environments, egress pod info is stored.,Any user input to this field will be overwritten by avi vantage.

Returns:

  • (Object, nil) —

    Metadata pertaining to the service provided by this virtual service.,In openshift/kubernetes environments, egress pod info is stored.,Any user input to this field will be overwritten by avi vantage.



223
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 223

attribute :service_metadata

#service_pool_select ⇒ Object?

Returns Select pool based on destination port.

Returns:

  • (Object, nil) —

    Select pool based on destination port.



226
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 226

attribute :service_pool_select

#services ⇒ Array<Hash>, ...

Returns List of services defined for this virtual service.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of services defined for this virtual service.



229
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 229

attribute :services

#sideband_profile ⇒ Object?

Returns Sideband configuration to be used for this virtualservice.it can be used for sending traffic to sideband vips for external inspection etc.

Returns:

  • (Object, nil) —

    Sideband configuration to be used for this virtualservice.it can be used for sending traffic to sideband vips for external inspection etc.



233
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 233

attribute :sideband_profile

#snat_ip ⇒ Object?

Returns Nat’ted floating source ip address(es) for upstream connection to servers.

Returns:

  • (Object, nil) —

    Nat’ted floating source ip address(es) for upstream connection to servers.



236
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 236

attribute :snat_ip

#sp_pool_refs ⇒ Object?

Returns Gslb pools used to manage site-persistence functionality.,Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the gslb manager.,This is a read-only field for the user.,It is a reference to an object of type pool.,Field introduced in 17.2.2.

Returns:

  • (Object, nil) —

    Gslb pools used to manage site-persistence functionality.,Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the gslb manager.,This is a read-only field for the user.,It is a reference to an object of type pool.,Field introduced in 17.2.2.



239
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 239

attribute :sp_pool_refs

#ssl_key_and_certificate_refs ⇒ Array<String>, ...

Returns Select or create one or two certificates, ec and/or rsa, that will be presented to ssl/tls terminated connections.,It is a reference to an object of type sslkeyandcertificate.

Returns:

  • (Array<String>, String, nil) —

    Select or create one or two certificates, ec and/or rsa, that will be presented to ssl/tls terminated connections.,It is a reference to an object of type sslkeyandcertificate.



242
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 242

attribute :ssl_key_and_certificate_refs

#ssl_profile_ref ⇒ String?

Returns Determines the set of ssl versions and ciphers to accept for ssl/tls terminated connections.,It is a reference to an object of type sslprofile.

Returns:

  • (String, nil) —

    Determines the set of ssl versions and ciphers to accept for ssl/tls terminated connections.,It is a reference to an object of type sslprofile.



246
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 246

attribute :ssl_profile_ref

#ssl_sess_cache_avg_size ⇒ Object?

Returns Expected number of ssl session cache entries (may be exceeded).,Allowed values are 1024-16383.,Default value when not specified in API or module is interpreted by Avi Controller as 1024.

Returns:

  • (Object, nil) —

    Expected number of ssl session cache entries (may be exceeded).,Allowed values are 1024-16383.,Default value when not specified in API or module is interpreted by Avi Controller as 1024.



250
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 250

attribute :ssl_sess_cache_avg_size

#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_virtualservice.rb', line 13

attribute :state

#static_dns_records ⇒ Object?

Returns List of static dns records applied to this virtual service.,These are static entries and no health monitoring is performed against the ip addresses.

Returns:

  • (Object, nil) —

    List of static dns records applied to this virtual service.,These are static entries and no health monitoring is performed against the ip addresses.



253
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 253

attribute :static_dns_records

#subnet ⇒ Object?

Returns Subnet providing reachability for client facing virtual service ip.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    Subnet providing reachability for client facing virtual service ip.,Field deprecated in 17.1.1.



256
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 256

attribute :subnet

#subnet_uuid ⇒ Object?

Returns It represents subnet for the virtual service ip address allocation when auto_allocate_ip is true.it is only applicable in openstack or aws cloud.,This field is required if auto_allocate_ip is true.,Field deprecated in 17.1.1.

Returns:

  • (Object, nil) —

    It represents subnet for the virtual service ip address allocation when auto_allocate_ip is true.it is only applicable in openstack or aws cloud.,This field is required if auto_allocate_ip is true.,Field deprecated in 17.1.1.



259
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 259

attribute :subnet_uuid

#tenant_ref ⇒ Object?

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

Returns:

  • (Object, nil) —

    It is a reference to an object of type tenant.



262
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 262

attribute :tenant_ref

#traffic_clone_profile_ref ⇒ Object?

Returns Server network or list of servers for cloning traffic.,It is a reference to an object of type trafficcloneprofile.,Field introduced in 17.1.1.

Returns:

  • (Object, nil) —

    Server network or list of servers for cloning traffic.,It is a reference to an object of type trafficcloneprofile.,Field introduced in 17.1.1.



265
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 265

attribute :traffic_clone_profile_ref

#traffic_enabled ⇒ Symbol?

Returns Knob to enable the virtual service traffic on its assigned service engines.,This setting is effective only when the enabled flag is set to true.,Field introduced in 17.2.8.,Default value when not specified in API or module is interpreted by Avi Controller as True.

Returns:

  • (Symbol, nil) —

    Knob to enable the virtual service traffic on its assigned service engines.,This setting is effective only when the enabled flag is set to true.,Field introduced in 17.2.8.,Default value when not specified in API or module is interpreted by Avi Controller as True.



268
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 268

attribute :traffic_enabled

#type ⇒ String?

Returns Specify if this is a normal virtual service, or if it is the parent or child of an sni-enabled virtual hosted virtual service.,Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD.,Default value when not specified in API or module is interpreted by Avi Controller as VS_TYPE_NORMAL.

Returns:

  • (String, nil) —

    Specify if this is a normal virtual service, or if it is the parent or child of an sni-enabled virtual hosted virtual service.,Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD.,Default value when not specified in API or module is interpreted by Avi Controller as VS_TYPE_NORMAL.



272
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 272

attribute :type

#url ⇒ Object?

Returns Avi controller URL of the object.

Returns:

  • (Object, nil) —

    Avi controller URL of the object.



276
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 276

attribute :url

#use_bridge_ip_as_vip ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



279
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 279

attribute :use_bridge_ip_as_vip

#use_vip_as_snat ⇒ Symbol?

Returns 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.,The caveat of enabling this option is that the virtualservice cannot be configued in an active-active ha mode.,Dns based multi vip solution has to be used for ha & non-disruptive upgrade purposes.,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.

Returns:

  • (Symbol, nil) —

    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.,The caveat of enabling this option is that the virtualservice cannot be configued in an active-active ha mode.,Dns based multi vip solution has to be used for ha & non-disruptive upgrade purposes.,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.



283
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 283

attribute :use_vip_as_snat

#uuid ⇒ Object?

Returns Uuid of the virtualservice.

Returns:

  • (Object, nil) —

    Uuid of the virtualservice.



287
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 287

attribute :uuid

#vh_domain_name ⇒ Object?

Returns The exact name requested from the client’s sni-enabled tls hello domain name field.,If this is a match, the parent vs will forward the connection to this child vs.

Returns:

  • (Object, nil) —

    The exact name requested from the client’s sni-enabled tls hello domain name field.,If this is a match, the parent vs will forward the connection to this child vs.



290
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 290

attribute :vh_domain_name

#vh_parent_vs_uuid ⇒ Object?

Returns Specifies the virtual service acting as virtual hosting (sni) parent.

Returns:

  • (Object, nil) —

    Specifies the virtual service acting as virtual hosting (sni) parent.



293
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 293

attribute :vh_parent_vs_uuid

#vip ⇒ Object?

Returns List of virtual service ips.,While creating a ‘shared vs’,please use vsvip_ref to point to the shared entities.,Field introduced in 17.1.1.

Returns:

  • (Object, nil) —

    List of virtual service ips.,While creating a ‘shared vs’,please use vsvip_ref to point to the shared entities.,Field introduced in 17.1.1.



296
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 296

attribute :vip

#vrf_context_ref ⇒ Object?

Returns Virtual routing context that the virtual service is bound to.,This is used to provide the isolation of the set of networks the application is attached to.,It is a reference to an object of type vrfcontext.

Returns:

  • (Object, nil) —

    Virtual routing context that the virtual service is bound to.,This is used to provide the isolation of the set of networks the application is attached to.,It is a reference to an object of type vrfcontext.



299
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 299

attribute :vrf_context_ref

#vs_datascripts ⇒ Object?

Returns Datascripts applied on the data traffic of the virtual service.

Returns:

  • (Object, nil) —

    Datascripts applied on the data traffic of the virtual service.



302
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 302

attribute :vs_datascripts

#vsvip_ref ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



305
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 305

attribute :vsvip_ref

#waf_policy_ref ⇒ Object?

Returns Waf policy for the virtual service.,It is a reference to an object of type wafpolicy.,Field introduced in 17.2.1.

Returns:

  • (Object, nil) —

    Waf policy for the virtual service.,It is a reference to an object of type wafpolicy.,Field introduced in 17.2.1.



308
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 308

attribute :waf_policy_ref

#weight ⇒ Object?

Returns The quality of service weight to assign to traffic transmitted from this virtual service.,A higher weight will prioritize traffic versus other virtual services sharing the same service engines.,Allowed values are 1-128.,Default value when not specified in API or module is interpreted by Avi Controller as 1.

Returns:

  • (Object, nil) —

    The quality of service weight to assign to traffic transmitted from this virtual service.,A higher weight will prioritize traffic versus other virtual services sharing the same service engines.,Allowed values are 1-128.,Default value when not specified in API or module is interpreted by Avi Controller as 1.



311
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_virtualservice.rb', line 311

attribute :weight