GET Secure Mesh site.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/securemesh_sites/example?response_format=GET_RSP_FORMAT_DEFAULT';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/securemesh_sites/example?response_format=GET_RSP_FORMAT_DEFAULT' \ --header 'Authorization: <Authorization>'Shape of the Secure Mesh site specification.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace The namespace in which the configuration object is present.
Name The name of the configuration object to be fetched.
Query Parameters
Section titled “Query Parameters”The format in which the configuration object is to be fetched. This could be for example
- in GetSpec form for the contents of object
- in CreateRequest form to create a new similar object
- to ReplaceRequest form to replace changeable values
Default format of returned resource Response should be in CreateRequest format Response should be in ReplaceRequest format Response should be in StatusObject(s) format Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object.
Responses
Section titled “Responses”A successful response.
This is the output message of the ‘GET’ RPC.
object
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 ""
object
Site’s geographical address that can be used to determine its latitude and longitude.
object
Blocking or denial configuration
Disable a node local service on this site.
object
object
object
object
object
List of bond devices
Required: YES.
Bond devices configuration for fleet.
object
object
Ethernet devices that will make up this bond Required: YES.
object
Interval in seconds to transmit LACP packets.
Link polling interval in milliseconds Required: YES.
Milliseconds wait before link is declared up Required: YES.
Name for the Bond. Ex ‘bond0’ Required: YES.
object
Latitude of the site location.
Longitude of site location.
object
object
Ordered List of Enhanced Firewall Policies active
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.
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. Required: YES.
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.
object
Ordered List of Forward Proxy Policies active
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.
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. Required: YES.
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.
object
Ordered List of Firewall Policies active for this network firewall
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.
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. Required: YES.
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.
object
object
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
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. Required: YES.
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.
object
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. Required: YES.
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.
object
Configure network interfaces for this Secure Mesh site
Required: YES.
Interface definition.
object
object
object
object
object
Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
Name of the device for which interface is configured Required: YES.
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
Description for this Interface.
object
object
Interface configuration for the ethernet device Required: YES.
object
object
object
object
List of networks from which DHCP Server can allocate IPv4 Addresses
Required: YES.
DHCP network configuration.
object
Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.
Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.
object
object
Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.
List of non overlapping IP address ranges.
DHCP pool is a range of IP addresses (start IP and end IP).
object
Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.
Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.
X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.
object
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. Required: YES.
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.
Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.
object
object
Specify static IPv4 addresses per site:node.
object
object
object
object
object
object
List of IPv6 Addresses acting as DNS servers Required: YES.
object
Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.
object
object
Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.
object
object
object
List of networks from which DHCP server can allocate IP addresses
Required: YES.
DHCP IPv6 network type configuration.
object
Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.
List of non overlapping IP address ranges.
DHCP IPv6 pool is a range of IP addresses (start IP and end IP).
object
Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.
Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.
Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.
object
object
Map of Site:Node to IPv6 address.
object
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
object
Exclusive with [cluster] Configuration will apply to a device on the given node.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Exclusive with [untagged] Configure a VLAN tagged ethernet interface.
Add Labels for this Interface, these labels can be used in firewall policy.
object
object
object
object
object
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. Required: YES.
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.
Add Labels for this network, these labels can be used in firewall policy.
object
Optional DNS V4 server IP to be used for name resolution.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
Optional common virtual V4 IP across all nodes to be used as automatic VIP.
object
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. Required: YES.
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.
Add Labels for this network, these labels can be used in firewall policy.
object
Optional DNS V4 server IP to be used for name resolution.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
Optional common virtual V4 IP across all nodes to be used as automatic VIP.
object
object
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.
object
object
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
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. Required: YES.
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.
object
Configuration of master nodes
Required: YES.
Master Node is the configuration of the master node.
object
Names of master node Required: YES.
IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.
object
object
object
object
object
object
Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.
object
object
object
object
object
object
object
Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.
Name for generic server certified hardware to form this Secure Mesh site. Required: YES.
Names of worker nodes.
The set of deleted objects that are referred by this object.
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.
The set of deleted objects that are referred by this object.
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
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 set of objects that are referring to this object in their spec.
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
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 ""
object
Site’s geographical address that can be used to determine its latitude and longitude.
object
Blocking or denial configuration
Disable a node local service on this site.
object
object
object
object
object
List of bond devices
Required: YES.
Bond devices configuration for fleet.
object
object
Ethernet devices that will make up this bond Required: YES.
object
Interval in seconds to transmit LACP packets.
Link polling interval in milliseconds Required: YES.
Milliseconds wait before link is declared up Required: YES.
Name for the Bond. Ex ‘bond0’ Required: YES.
object
Latitude of the site location.
Longitude of site location.
object
object
Ordered List of Enhanced Firewall Policies active
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.
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. Required: YES.
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.
object
Ordered List of Forward Proxy Policies active
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.
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. Required: YES.
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.
object
Ordered List of Firewall Policies active for this network firewall
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.
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. Required: YES.
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.
object
object
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
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. Required: YES.
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.
object
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. Required: YES.
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.
object
Configure network interfaces for this Secure Mesh site
Required: YES.
Interface definition.
object
object
object
object
object
Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
Name of the device for which interface is configured Required: YES.
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
Description for this Interface.
object
object
Interface configuration for the ethernet device Required: YES.
object
object
object
object
List of networks from which DHCP Server can allocate IPv4 Addresses
Required: YES.
DHCP network configuration.
object
Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.
Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.
object
object
Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.
List of non overlapping IP address ranges.
DHCP pool is a range of IP addresses (start IP and end IP).
object
Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.
Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.
X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.
object
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. Required: YES.
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.
Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.
object
object
Specify static IPv4 addresses per site:node.
object
object
object
object
object
object
List of IPv6 Addresses acting as DNS servers Required: YES.
object
Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.
object
object
Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.
object
object
object
List of networks from which DHCP server can allocate IP addresses
Required: YES.
DHCP IPv6 network type configuration.
object
Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.
List of non overlapping IP address ranges.
DHCP IPv6 pool is a range of IP addresses (start IP and end IP).
object
Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.
Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.
Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.
object
object
Map of Site:Node to IPv6 address.
object
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
object
Exclusive with [cluster] Configuration will apply to a device on the given node.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Exclusive with [untagged] Configure a VLAN tagged ethernet interface.
Add Labels for this Interface, these labels can be used in firewall policy.
object
object
object
object
object
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. Required: YES.
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.
Add Labels for this network, these labels can be used in firewall policy.
object
Optional DNS V4 server IP to be used for name resolution.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
Optional common virtual V4 IP across all nodes to be used as automatic VIP.
object
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. Required: YES.
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.
Add Labels for this network, these labels can be used in firewall policy.
object
Optional DNS V4 server IP to be used for name resolution.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
Optional common virtual V4 IP across all nodes to be used as automatic VIP.
object
object
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.
object
object
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
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. Required: YES.
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.
object
Configuration of master nodes
Required: YES.
Master Node is the configuration of the master node.
object
Names of master node Required: YES.
IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.
object
object
object
object
object
object
Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.
object
object
object
object
object
object
object
Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.
Name for generic server certified hardware to form this Secure Mesh site. Required: YES.
Names of worker nodes.
object
Site’s geographical address that can be used to determine its latitude and longitude.
object
Blocking or denial configuration
Disable a node local service on this site.
object
object
object
object
object
List of bond devices
Required: YES.
Bond devices configuration for fleet.
object
object
Ethernet devices that will make up this bond Required: YES.
object
Interval in seconds to transmit LACP packets.
Link polling interval in milliseconds Required: YES.
Milliseconds wait before link is declared up Required: YES.
Name for the Bond. Ex ‘bond0’ Required: YES.
object
Latitude of the site location.
Longitude of site location.
object
object
Ordered List of Enhanced Firewall Policies active
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.
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. Required: YES.
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.
object
Ordered List of Forward Proxy Policies active
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.
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. Required: YES.
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.
object
Ordered List of Firewall Policies active for this network firewall
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.
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. Required: YES.
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.
object
object
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
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. Required: YES.
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.
object
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. Required: YES.
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.
object
Configure network interfaces for this Secure Mesh site
Required: YES.
Interface definition.
object
object
object
object
object
Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
Name of the device for which interface is configured Required: YES.
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
Description for this Interface.
object
object
Interface configuration for the ethernet device Required: YES.
object
object
object
object
List of networks from which DHCP Server can allocate IPv4 Addresses
Required: YES.
DHCP network configuration.
object
Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.
Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.
object
object
Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.
List of non overlapping IP address ranges.
DHCP pool is a range of IP addresses (start IP and end IP).
object
Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.
Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.
X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.
object
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. Required: YES.
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.
Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.
object
object
Specify static IPv4 addresses per site:node.
object
object
object
object
object
object
List of IPv6 Addresses acting as DNS servers Required: YES.
object
Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.
object
object
Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.
object
object
object
List of networks from which DHCP server can allocate IP addresses
Required: YES.
DHCP IPv6 network type configuration.
object
Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.
List of non overlapping IP address ranges.
DHCP IPv6 pool is a range of IP addresses (start IP and end IP).
object
Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.
Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.
Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.
object
object
Map of Site:Node to IPv6 address.
object
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
object
Exclusive with [cluster] Configuration will apply to a device on the given node.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Exclusive with [untagged] Configure a VLAN tagged ethernet interface.
Add Labels for this Interface, these labels can be used in firewall policy.
object
object
object
object
object
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. Required: YES.
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.
Add Labels for this network, these labels can be used in firewall policy.
object
Optional DNS V4 server IP to be used for name resolution.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
Optional common virtual V4 IP across all nodes to be used as automatic VIP.
object
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. Required: YES.
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.
Add Labels for this network, these labels can be used in firewall policy.
object
Optional DNS V4 server IP to be used for name resolution.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
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.
Node name on this site.
Optional common virtual V4 IP across all nodes to be used as automatic VIP.
object
object
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.
object
object
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
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. Required: YES.
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.
object
Configuration of master nodes
Required: YES.
Master Node is the configuration of the master node.
object
Names of master node Required: YES.
IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.
object
object
object
object
Desired Operating System version that should be installed on the site.
object
object
object
object
object
Name for generic server certified hardware to form this Secure Mesh site. Required: YES.
Desired F5 Distributed Cloud software version that should be installed on the site.
Names of worker nodes.
The status reported by different services for this configuration object.
Most recently observed status of object.
object
Conditions represent the normalized status values for configuration object.
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
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.
F5XC Secure Mesh site object direct reference.
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
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.
Example
{ "create_form": { "spec": { "blocked_services": { "blocked_sevice": [ { "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } ] }, "custom_network_config": { "interface_list": { "interfaces": [ { "ethernet_interface": { "dhcp_server": { "dhcp_networks": [ { "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" } ] }, "ipv6_auto_config": { "router": { "stateful": { "dhcp_networks": [ { "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" } ] } } } } } ] }, "sli_config": { "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] } }, "slo_config": { "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] } }, "vip_vrrp_mode": "VIP_VRRP_INVALID" } } }, "replace_form": { "spec": { "blocked_services": { "blocked_sevice": [ { "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } ] }, "custom_network_config": { "interface_list": { "interfaces": [ { "ethernet_interface": { "dhcp_server": { "dhcp_networks": [ { "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" } ] }, "ipv6_auto_config": { "router": { "stateful": { "dhcp_networks": [ { "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" } ] } } } } } ] }, "sli_config": { "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] } }, "slo_config": { "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] } }, "vip_vrrp_mode": "VIP_VRRP_INVALID" } } }, "spec": { "blocked_services": { "blocked_sevice": [ { "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } ] }, "custom_network_config": { "interface_list": { "interfaces": [ { "ethernet_interface": { "dhcp_server": { "dhcp_networks": [ { "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" } ] }, "ipv6_auto_config": { "router": { "stateful": { "dhcp_networks": [ { "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" } ] } } } } } ] }, "sli_config": { "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] } }, "slo_config": { "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ] } ] } }, "vip_vrrp_mode": "VIP_VRRP_INVALID" }, "site_state": "ONLINE" }, "status": [ { "metadata": { "publish": "STATUS_DO_NOT_PUBLISH" } } ]}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