PATCH /vsvip/{uuid}
/vsvip/{uuid}
UUID of the object to fetch
object name
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
{
"_last_modified": "string",
"bgp_local_preference": 0,
"bgp_num_as_path_prepend": 0,
"bgp_peer_labels": [
"string"
],
"cloud_ref": "string",
"configpb_attributes": {
"version": 0
},
"dns_info": [
{
"algorithm": "string",
"cname": {
"cname": "string"
},
"fqdn": "string",
"metadata": "string",
"num_records_in_response": 0,
"ttl": 0,
"type": "string"
}
],
"east_west_placement": false,
"ipam_selector": {
"labels": [
{
"key": "string",
"value": "string"
}
],
"type": "string"
},
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"name": "string",
"tenant_ref": "string",
"tier1_lr": "string",
"url": "string",
"use_standard_alb": false,
"uuid": "string",
"vip": [
{
"auto_allocate_floating_ip": false,
"auto_allocate_ip": false,
"auto_allocate_ip_type": "string",
"availability_zone": "string",
"avi_allocated_fip": false,
"avi_allocated_vip": false,
"discovered_networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"enabled": false,
"floating_ip": {
"addr": "string",
"type": "string"
},
"floating_ip6": {
"addr": "string",
"type": "string"
},
"floating_subnet6_uuid": "string",
"floating_subnet_uuid": "string",
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"ipam_network_subnet": {
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string"
},
"network_ref": "string",
"placement_networks": [
{
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"port_uuid": "string",
"prefix_length": 0,
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string",
"vip_id": "string"
}
],
"vrf_context_ref": "string",
"vsvip_cloud_config_cksum": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
LOCAL_PREF to be used for VsVip advertised. Applicable only over iBGP. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Number of times the local AS should be prepended additionally to VsVip. Applicable only over eBGP. Allowed values are 1-10. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Select BGP peers, using peer label, for VsVip advertisement. Field introduced in 20.1.5. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
It is a reference to an object of type Cloud. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. This takes effect only if dns profile isassociated with cloud. Field introduced in 17.1.1. Maximum of 1000 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Name for the VsVip object. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
UUID of the VsVip object. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
List of Virtual Service IPs and other shareable entities. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
OK
{
"_last_modified": "string",
"bgp_local_preference": 0,
"bgp_num_as_path_prepend": 0,
"bgp_peer_labels": [
"string"
],
"cloud_ref": "string",
"configpb_attributes": {
"version": 0
},
"dns_info": [
{
"algorithm": "string",
"cname": {
"cname": "string"
},
"fqdn": "string",
"metadata": "string",
"num_records_in_response": 0,
"ttl": 0,
"type": "string"
}
],
"east_west_placement": false,
"ipam_selector": {
"labels": [
{
"key": "string",
"value": "string"
}
],
"type": "string"
},
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"name": "string",
"tenant_ref": "string",
"tier1_lr": "string",
"url": "string",
"use_standard_alb": false,
"uuid": "string",
"vip": [
{
"auto_allocate_floating_ip": false,
"auto_allocate_ip": false,
"auto_allocate_ip_type": "string",
"availability_zone": "string",
"avi_allocated_fip": false,
"avi_allocated_vip": false,
"discovered_networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"enabled": false,
"floating_ip": {
"addr": "string",
"type": "string"
},
"floating_ip6": {
"addr": "string",
"type": "string"
},
"floating_subnet6_uuid": "string",
"floating_subnet_uuid": "string",
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"ipam_network_subnet": {
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string"
},
"network_ref": "string",
"placement_networks": [
{
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"port_uuid": "string",
"prefix_length": 0,
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string",
"vip_id": "string"
}
],
"vrf_context_ref": "string",
"vsvip_cloud_config_cksum": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
LOCAL_PREF to be used for VsVip advertised. Applicable only over iBGP. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Number of times the local AS should be prepended additionally to VsVip. Applicable only over eBGP. Allowed values are 1-10. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Select BGP peers, using peer label, for VsVip advertisement. Field introduced in 20.1.5. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
It is a reference to an object of type Cloud. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. This takes effect only if dns profile isassociated with cloud. Field introduced in 17.1.1. Maximum of 1000 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Name for the VsVip object. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
UUID of the VsVip object. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
List of Virtual Service IPs and other shareable entities. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed