VirtualIP

Virtual IPs are IP addresses owned by one or more vports that can move among those vports. VSP will track the owner of a virtual IP and steer traffic accordingly. Virtual IPs can be used as next-hops for static routes and other re-direction purposes.

Overview

associatedFloatingIPID string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPType enum (IPV4 | IPV6) filterable   orderable  
lastUpdatedBy string autogenerated  
MAC string
subnetID string
virtualIP string required   filterable   orderable  

API Resource

/virtualips/id
delete get put

Parents

/redirectiontargets/id/virtualips
get post
/vports/id/virtualips
get post
/subnets/id/virtualips
get

Children

/virtualips/id/metadatas
get post
/virtualips/id/globalmetadatas
get post put
/virtualips/id/eventlogs
get

Members

This object has no members.

Attributes documentation

associatedFloatingIPID string
Discussion

Id of Floating IP address associated to this virtual ip

Charateristics

Format: free
SDK attribute: associatedFloatingIPID

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

IPType enum filterable   orderable  
Discussion

Specify if the virtualIP attribute value is in IPv4 or IPv6 format

Charateristics

Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: IPType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

MAC string
Discussion

The MAC address of the virtual port

Charateristics

Format: free
SDK attribute: MAC

subnetID string
Discussion

ID of subnet to which this IP address belongs

Charateristics

Format: free
SDK attribute: subnetID

virtualIP string required   filterable   orderable  
Discussion

Virtual IP address

Charateristics

Format: free
SDK attribute: virtualIP