List Site
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/sites';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/sites \ --header 'Authorization: <Authorization>'List the set of site in a namespace.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace Namespace to scope the listing of site.
Query Parameters
Section titled “Query Parameters”A LabelSelectorType expression that every item in list response will satisfy.
X-example: "" Extra fields to return along with summary fields.
X-example: "" Extra status fields to return along with summary fields.
Responses
Section titled “Responses”A successful response.
This is the output message of ‘List’ RPC.
object
Errors(if any) while listing items from collection.
Information about a error in API operation.
object
object
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one ”/” character. The last segment of the URL’s path must represent
the fully qualified name of the type (as in
path/google.protobuf.duration). The name should be in a canonical form
(e.g., leading ”.” is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme HTTP, HTTPS, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
- If no scheme is provided,
HTTPSis assumed. - An HTTP GET on the URL must yield a [google.protobuf.type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than HTTP, HTTPS (or the empty scheme) might be
used with implementation specific semantics.
Must be a valid serialized protocol buffer of the above specified type.
A human readable string of the error.
Items represents the collection in response.
By default a summary of site is returned in ‘List’. By setting ‘report_fields’ in the ListRequest more details of each item can be got.
object
The set of annotations present on this site.
object
The description set for this site.
A value of true indicates site is administratively disabled.
object
Site’s geographical address that can be used to determine its latitude and longitude.
object
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Provided Public SSH key can be used for accessing nodes of the site. When provided, customers can SSH to the nodes of this Customer Edge site using admin as the user.
Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer addres per site in fleet.
Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configurred to fetch BGP router ID from site object. This can be used to change router ID per site in a fleet.
Following fields are only for customer edge sites List of REs to which to which this CE initiates IPsec/SSL connection to
Required: YES.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
This field is valid only for CE site object List of REs which can send config to this CE site
Required: YES.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Latitude of the site location.
Longitude of site location.
object
object
object
Desired pool count represent desired number of worker(non master) nodes for manual scaling of public cloud(AWS, GCP, Azure) sites. The desired count must be less than or equal to the maximum size of the scaling group for a given public cloud. One may also have to increase maximum scaling group size to effectively increase desired pool count.
Enable or disable functionality flag
Optional DNS server IP to be used for name resolution in inside network.
Optional Virtual IP to be used as automatic VIP for site local inside network. See documentation for “VIP” in advertise policy to see when Inside VIP is used. When configured, this is used as VIP (depending on advertise policy configuration). When not configured, site local inside interface IP will be used as VIP.
FQDN resolves to responders node IP, if there are multiple nodes at site the resolution will give a list of all/some individual node IP. Multiple FQDN for same site is also allowed.
object
object
object
object
Exclusive with []
Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).
Required: YES.
object
Enable or disable functionality flag
Lets user know if this site has local K8s cluster enabled via fleet configuration.
Connectivity information of main/master nodes to create a full mesh of Phobos services across all CEs in a site-mesh-group or dc-cluster-group.
Node Information for connectivity across sites.
object
Name of the master/main node on the site.
Site Local Inside IP address.
Site Local Outside IP address.
Indicates that Multus cni is enabled on the site.
Desired Operating System version for this site.
Optional DNS server IP to be used for name resolution in outside network.
Optional Virtual IP to be used as automatic VIP for site local outside network. See documentation for “VIP” in advertise policy to see when Outside VIP is used. When configured, this is used as VIP (depending on advertise policy configuration). When not configured, site local interface IP will be used as VIP.
object
object
Name of the the CloudLink used with this site.
ADN Network Name for private access connectivity to F5XC ADN.
object
object
object
Select primary RE for this site.
Select backup RE for this site, cannot be the same as Primary RE.
Cloud Region. A region is a set of datacenters deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.
Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.
Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.
Optional Publish VIP Parameters Per AZ for public cloud sites. See documentation for “VIP” in advertise policy to see when Inside VIP or Outside VIP is used. When configured, the VIP(s) defined will be used to publish to external systems like K8s, Consul.
Per AZ parameters needed to publish VIP for public cloud sites.
object
Name of the Availability zone.
List of Inside VIPs for an AZ.
CNAME value for the inside VIP, These are usually public cloud generated CNAME.
Optional list of Inside IPv6 VIPs for an AZ.
List of Outside VIPs for an AZ Required: YES.
CNAME value for the outside VIP These are usually public cloud generated CNAME.
Optional list of Outside IPv6 VIPs for an AZ.
Indicates that virtual machine support is enabled on the site.
Desired F5XC software version for this site, a string matching released set of software components.
The set of labels present on this site.
object
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
object
Human readable description for the object.
A value of true will administratively disable the object.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.
object
This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.
This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""
The name of this site.
The namespace this item belongs to.
object
Kind of the view object.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
UID of the view object.
The status reported by different services for this configuration object.
Most recently observed status of site object.
object
Certified Hardware identifies what F5XC Certified Hardware is deployed at this site.
Conditions.
Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.
object
Hostname of the instance of the site that sent the status.
Last time the condition was updated.
X-reason: “Insufficient memory in data plane” A human readable string explaining the reason for reaching this condition.
Name of the service that sent the status.
Status of the condition “Success” Validtion has succeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.
Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.
object
The list of sites in the dc cluster group and information about each
Required: YES.
Information about a particular site.
object
The list of annotations providing information about the referenced site.
Required: YES.
‘site’ refers to a site.
Required: YES.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
Container image version.
Error output of terraform run.
ModificationTimestamp is a timestamp representing the server time when this status was last modified.
Suggested action for customer on error.
The value of an “output” variable from the terraform state file.
The stdout of terraform apply command.
Container version expected.
object
Error output of terraform run.
ModificationTimestamp is a timestamp representing the server time when this status was last modified.
Suggested action for customer on error.
Terraform “plan” command output. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files.
object
Direct Connect Gateway ID.
Direct Connect Gateway state.
Virtual Private Gateway association state.
Propagated Routes from Direct Connect Connection.
Virtual Private Gateway ID.
Virtual Private Gateway state.
VIF States.
object
VIF Attachment State.
BGP Peers
object
Address Family.
Amazon side address.
Configuration parameter for asn
BGP Peer ID.
BGP Peer State.
BGP Status.
Customer side Address.
VIF ID
VIF State
object
Propagated Routes from Azure Express Route.
object
Route Server Peering State.
object
Route Server Peer IP.
Route Server Peer ASN.
Provisioning Status.
Route Server Name.
object
Azure Express Route Circuit Connection Status.
object
Express Route Circuit ID.
Express Route Circuit Name.
Express Route Provisioning State.
Express Route Connection Name.
Express Route Connection Status.
object
Express Route Azure ASN.
Express Route Peer ASN.
Express Route Peering Type.
Provisioning Status.
Express Route Peering Status.
VNet Gateway ID.
VNet Gateway Name.
VNet Gateway State.
object
object
Map of fleet conditions.
object
A verbose human readable explanation of the reason.
A name of module that produced the condition.
A name of condition.
Result of the condition.
Hash sum of fleet config.
ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.
Summarized result of the deployment, one of Success, Failure, Unknown.
Hostname of node in site.
object
object
Information from /sys/class/dmi/ID/bios_date.
Information from /sys/class/dmi/ID/bios_vendor.
Information from /sys/class/dmi/ID/bios_version.
object
Information from /sys/class/dmi/ID/board_asset_tag.
Information from /sys/class/dmi/ID/board_name.
Information from /sys/class/dmi/ID/board_serial.
Information from /sys/class/dmi/ID/board_vendor.
Information from /sys/class/dmi/ID/board_version.
object
Information from /sys/class/dmi/ID/chassis_asset_tag.
Information from /sys/class/dmi/ID/chassis_serial.
Information from /sys/class/dmi/ID/chassis_type.
Information from /sys/class/dmi/ID/chassis_vendor.
Information from /sys/class/dmi/ID/chassis_version.
object
CPU cache size in KB.
Number of physical CPU cores.
Number of physical CPUs.
CPU model
CPU clock rate in MHz.
Number of logical (HT) CPU cores.
CPU vendor.
object
GPU Cuda Version.
GPU Driver Version.
List of GPU devices in server.
object
GPU ID
GPU Processes.
GPU Product Name.
object
Kernel architecture.
Kernel release.
Kernel version.
object
RAM size in MB.
RAM data rate in MT/s.
Type of memory, eg. DDR4.
List of network devices in server.
NetworkDevice information.
object
Driver of device, eg. E1000e.
IP address on interface.
MAC address on interface.
Name of device, eg. Eth0.
Used port, eg. Tp.
Device max supported speed in Mbps.
Non-uniform memory access (NUMA) nodes count.
object
Architecture of OS.
Name of OS.
Release of the OS.
Vendor of OS.
Version of OS.
object
Product name, eg. For AWS m5a.xlarge. Info taken from /sys/class/dmi/ID/product_name.
Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/ID/product_serial.
Vendor name, eg. For AWS Amazon EC2. Info taken from /sys/class/dmi/ID/product_vendor.
Version name. Info taken from /sys/class/dmi/ID/product_version.
List of storage devices in server.
StorageDevice information.
object
Driver of device.
Model of device.
Name of device, eg. Nvme0n1.
Serial of device.
Device size in GB.
Vendor of device.
List of USB devices in server.
Information about USB device.
object
Address of the device on the bus in decimal.
The class of this device.
The protocol (within the sub-class) of this device.
The sub-class (within the class) of this device.
Maximum size of the control transfer.
The device version.
USB Specification Release Number.
The bus on which the device was detected in decimal.
Device description.
Manufacturer name.
Product name reported by device.
Index of Serial Number String Descriptor.
Product ID (Assigned by Manufacturer) in hex.
Vendor ID (Assigned by USB Org) in hex.
Port on which the device was detected in decimal.
Product ID translated to name (if available)
The negotiated operating speed for the device.
Vendor ID translated to name (if available)
object
Configuration parameter for arn
Human-readable name for the resource
NLB CNAME
NLB Status.
Reason
Target Group Status.
object
Configuration parameter for arn
Listener status.
object
Configuration parameter for arn
TCP/UDP port number (1-65535)
Protocol
Reason
Status
Human-readable name for the resource
Protocol
Reason
Status
object
Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.
Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.
ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.
Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)
Uid is the unique in time and space value for a StatusObject.
Origin of this status exchanged by VTRP.
Indicate whether mars deems this object to be stale via graceful restart timer information.
object
Hostname of the node.
Role of registered node. Roles are used by system to determine what control services they should enforce. K8s-master represents Kubernetes Master.
Site object reference for which this status object is generated.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Provides more detailed description of current phase.
object
Available version represent F5 Distributed Cloud operating system version ready to be upgraded in the site.
object
A verbose human readable explanation of the reason.
ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.
Result of the deployment, one of Success, Failure, Unknown.
Version name for this deployment state.
If nonconforming state is not empty, then current deployed OS version is nonconforming. Site should be upgrade to available version.
object
Provides description of scaling action, eg. “scaled to 3 nodes”
Current number of pool nodes in cluster.
Desired pool node count defines how many nodes should be in a cluster after scaling.
object
List of sites connected by this Site Mesh Group.
The list of sites in the site mesh group and information about each.
Information about a particular site.
object
The list of annotations providing information about the referenced site.
Required: YES.
‘site’ refers to a site.
Required: YES.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
List of SiteReachabilityStatus status shows status of domain reachability during registration.
F5XC domain reachability in the site.
object
The error message during network reachbility scan.
Name of the node on the site.
Result of the domain reachability scan.
object
object
Timestamp at which the VER became cluster master.
UID of Master VER in the Cluster.
Instance name of Master VER in the Cluster.
object
Status of every Ares connections this Ver is connecting to for routes.
Status of Ares Connection.
object
URL identifies the Ares server.
Status/details of every configured connection this Ver is originating.
Status of tunnel connection that a Ver has originated / terminated.
object
Internal reference to BGP object corresponding to this tunnel.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Flap reason for tunnel.
Flap time for tunnel.
Identifies if the IPsec connection is local to the ver node or not.
IP address of the remote end.
object
Flap reason for tunnel.
Flap time for tunnel.
Internal reference to Tunnel object corresponding to this status.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Tunnel name.
URL identifies the other end of the Ver for tunnel origination/termination.
The VER node IP in the local site from which the connection is setup.
The VER node in the local site from which the connection is setup.
Status/details of every tunnel configured as external connector.
Status of tunnel connection that a Ver has originated / terminated.
object
Internal reference to BGP object corresponding to this tunnel.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Flap reason for tunnel.
Flap time for tunnel.
Identifies if the IPsec connection is local to the ver node or not.
IP address of the remote end.
object
Flap reason for tunnel.
Flap time for tunnel.
Internal reference to Tunnel object corresponding to this status.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Tunnel name.
URL identifies the other end of the Ver for tunnel origination/termination.
The VER node IP in the local site from which the connection is setup.
The VER node in the local site from which the connection is setup.
Status of every inside or outside interface present in this VER.
Status of Interfaces in ver.
object
Members of the Bond interface along with the corresponding link state.
BondMembersType represents the bond interface members along with the corresponding link state.
object
Link speed of Bond Interface Member in Mbps.
Link state of Bond Interface Member.
Name of the Bond Interface Member.
Indicate if DHCP server is configured on the interface.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Link State for the interface.
MAC Address of interface.
Name of interface.
Name of Virtual Network to which the interface belongs.
object
Description gives the reason for ver being in this state.
Status/details of every site connection this Ver is originating/ terminating.
Status of tunnel connection that a Ver has originated / terminated.
object
Internal reference to BGP object corresponding to this tunnel.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Flap reason for tunnel.
Flap time for tunnel.
Identifies if the IPsec connection is local to the ver node or not.
IP address of the remote end.
object
Flap reason for tunnel.
Flap time for tunnel.
Internal reference to Tunnel object corresponding to this status.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Tunnel name.
URL identifies the other end of the Ver for tunnel origination/termination.
The VER node IP in the local site from which the connection is setup.
The VER node in the local site from which the connection is setup.
Name of the ver instance that created this site status.
object
object
Configuration parameter for peers
object
Azure VNet Peering State.
Azure VNet Peering Sync Level.
Provisioning State.
Remote VNet ID.
Remote Route association State.
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
Spoke VNETs.
object
Configuration parameter for peers
object
Azure VNet Peering State.
Azure VNet Peering Sync Level.
Provisioning State.
Remote VNet ID.
Remote Route association State.
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
Available version represent F5 Distributed Cloud software version ready to be upgraded in the site.
object
A verbose human readable explanation of the reason.
ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.
Result of the deployment, one of Success, Failure, Unknown.
Version name for this deployment state.
Last installed version represent last F5 Distributed Cloud software version that has successfully deployed in the site.
If nonconforming state is not empty, then current deployed SW version is nonconforming. Site should be upgrade to available version.
Expiry date of software version in YYYY-MM-DD.
object
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
A value identifying the class of the user or service which created this configuration object.
A value identifying the exact user or service that created this configuration object.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
object
Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
Initializer is information about an initializer that has not yet completed.
object
Name of the service that is responsible for initializing this object.
object
Suggested HTTP return code for this status, 0 if not set.
A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.
Status of the operation. One of: “Success” or “Failure”.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).
object
ModificationTimestamp is a timestamp representing the server time when this object was last modified.
Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.
object
Kind of the view object.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
UID of the view object.
Tenant to which this configuration object belongs to. The value for this is found from presented credentials.
Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.
The tenant this item belongs to.
The unique uid of this site.
Example
{ "errors": [ { "code": "EOK" } ], "items": [ { "get_spec": { "admin_user_credentials": { "admin_password": { "secret_encoding_type": "EncodingNone", "vault_secret_info": { "secret_encoding": "EncodingNone" } } }, "ce_site_mode": "CE_SITE_MODE_INGRESS_EGRESS_GW", "private_connectivity": { "cloud_link": { "state": "UP" } }, "site_state": "ONLINE", "site_subtype": "NO_SUBTYPE", "site_to_site_network_type": "VIRTUAL_NETWORK_SITE_LOCAL", "site_type": "INVALID", "tunnel_type": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL", "vip_vrrp_mode": "VIP_VRRP_INVALID", "volterra_software_overide": "SITE_SOFTWARE_OVERRIDE_SITE" }, "status_set": [ { "deployment": { "apply_status": { "apply_state": "APPLIED", "destroy_state": "DESTROYED", "infra_state": "PROVISIONED" }, "plan_status": { "infra_state": "PROVISIONED", "plan_state": "PLANNING" } }, "hw_info": { "network": [ { "link_quality": "QUALITY_UNKNOWN", "link_type": "LINK_TYPE_UNKNOWN" } ], "usb": [ { "usb_type": "UNKNOWN_USB" } ] }, "metadata": { "publish": "STATUS_DO_NOT_PUBLISH" }, "offline_survivability_status": { "phase": "OFFLINE_DISABLED" }, "operating_system_status": { "deployment_state": { "phase": "UPGRADE_INVALID" } }, "scaling_status": { "phase": "SCALING_INVALID" }, "ver_status": { "ares_status": [ { "state": "INIT" } ], "configured_tunnel_status": [ { "bgp_peer_protocol_state": "Unknown", "bgp_status": "BGP_PEER_DOWN", "encap": "IPSEC_PKI", "role": "UNKNOWN_TUNNEL_ROLE", "state": "UNKNOWN_TUNNEL_STATE" } ], "ext_connector_tunnel_status": [ { "bgp_peer_protocol_state": "Unknown", "bgp_status": "BGP_PEER_DOWN", "encap": "IPSEC_PKI", "role": "UNKNOWN_TUNNEL_ROLE", "state": "UNKNOWN_TUNNEL_STATE" } ], "intf_status": [ { "active_state": "STATE_UNKNOWN", "ip_mode": "STATIC", "link_quality": "QUALITY_UNKNOWN", "link_type": "LINK_TYPE_UNKNOWN", "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } ], "running_state_status": { "state": "OPERATIONAL_READY" }, "site_tunnel_status": [ { "bgp_peer_protocol_state": "Unknown", "bgp_status": "BGP_PEER_DOWN", "encap": "IPSEC_PKI", "role": "UNKNOWN_TUNNEL_ROLE", "state": "UNKNOWN_TUNNEL_STATE" } ] }, "volterra_software_status": { "deployment_state": { "phase": "UPGRADE_INVALID" } } } ] } ]}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example