Properties are collected for the virtual service object type.
Virtual Service Properties
| Property Name | Category | Description |
|---|---|---|
| Name | Summary | Name of the object. |
| UUID | Summary | UUID of the object to be fetched. |
| Status | Summary | Enable or disable the Virtual Service. |
| Traffic Enabled | Summary | Knob to enable the Virtual Service traffic on its assigned service engines. |
| VIP Address | Summary | Virtual IP address. |
| IPv4 Address | Summary | IPv4 address of the virtual IP. |
| IPv6 Address | Summary | IPv6 address of the virtual IP. |
| Application Domain Name | Summary | Fully qualified domain name. |
| VS VIP | Summary | Indicates the vip_id that needs placement retrial. |
| Cloud | Summary | Reference to an object of type Cloud. |
| Status | Summary | Boolean value suggesting whether the virtual service is up or not. |
| Pools | Summary | Pools to which the virtual service has to load balance to. |
| Virtual Hosting | Summary | Specifies the virtual service acting as virtual hosting (SNI) parent. Reference to an object of type VirtualService. |
| VRF Context | Summary | 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. Reference to an object of type VrfContext. |
| Service Port 1 | Service Port | The Virtual Service's port number. |
| Service Port 2 | Service Port | The Virtual Service's port number. |
| Service Port N | Service Port | The Virtual Service's port number. |
| TCP/UDP Profile | Profiles | Determines network settings such as protocol, TCP or UDP, and related options for the protocol. Reference to an object of type NetworkProfile. |
| Application Profile | Profiles | Enables application layer specific features for the Virtual Service. Reference to an object of type ApplicationProfile. |
| Error Page Profile | Profiles | This profile is used to send the custom error page to the client generated by the proxy. Reference to an object of type ErrorPageProfile. |
| Name | Pool Type | An object that contains destination servers and related attributes such as load-balancing and persistence. Reference to an object of type Pool. |
| Pool Group | Pool Type | Reference to an object of type Pool. |
| Analytics Profile | Analytics | Specifies settings related to analytics. Reference to an object of type AnalyticsProfile. |
| Metrics Update Frequency | Analytics | Settings to set duration for real time updates. |
| Real Time Metrics | Analytics | Settings to turn on real time metrics. |
| Significant Log Throttle | Client Log Settings | This setting limits the number of significant logs generated per second for the virtual service on each service engine. |
| User defined filters Log Throttle | Client Log Settings | This setting limits the total number of UDF logs generated per second for the virtual service on each service engine. UDF logs are generated because of the configured client log filters or the rules with logging enabled. |
| Non Significant Logs | Client Log Settings | Captures all client logs including connections and requests. |
| Non-significant log throttle | Client Log Settings | Limits the number of non-significant logs generated per second for this virtual service on each service engine. Default is 10 logs per second. |
| Non-significant log duration | Client Log Settings | Amount of time the system captures all the logs, measured in minutes. |
| Name 1 | Client Log Filter | Description of property client_log_filters of object type AnalyticsPolicy. |
| Name 2 | Client Log Filter | Description of property client_log_filters of object type AnalyticsPolicy. |
| Name 3 | Client Log Filter | Description of property client_log_filters of object type AnalyticsPolicy. |
| Weight | Quality of Service | The Quality of Service weight to assign to traffic transmitted from the virtual service. A higher weight will prioritize traffic versus other virtual services sharing the same service engines. |
| Fairness | Quality of Service | Determines how multiple virtual services sharing the same service engines will prioritize traffic over a congested network. |
| Auto Gateway | Other Settings | Response traffic to clients will be sent back to the source MAC address of the connection, rather than statically sent to a default gateway. |
| Use VIP as SNAT | Other Settings | Uses the virtual IP as the SNAT IP for health monitoring and sends traffic to the backend servers instead of the service engine interface IP. |
| Advertise VIP via BGP | Other Settings | Advertises a virtual service via BGP even if it is marked down by the health monitor. |
| Advertise SNAT via BGP | Other Settings | Enables Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context |
| SE Group | Other Settings | The service engine group to use for this virtual service. Reference to an object of type ServiceEngineGroup. |
| SNAT IP Address | Other Settings | Natted floating source IP Address(es) for upstream connection to servers. |
| Traffic Clone Profile | Other Settings | Server network or list of servers for cloning traffic. Reference to an object of type TrafficCloneProfile. |
| Remove Listening Port when VS down | Other Settings | Removes listening port if the virtual service is down. |
| Scale Out ECMP | Other Settings | 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. |
| Service Ports | ServicePort | Port number. |
| Protocol | ServicePort | Type of protocol. |
