Create Fleet.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/fleets';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"metadata":{"annotations":{},"description":"example","disable":true,"labels":{},"name":"example","namespace":"example"},"spec":{"allow_all_usb":{},"blocked_services":[{"dns":{},"network_type":"VIRTUAL_NETWORK_SITE_LOCAL","ssh":{},"web_user_interface":{}}],"bond_device_list":{"bond_devices":[{"active_backup":{},"devices":["example"],"lacp":{"rate":1},"link_polling_interval":1,"link_up_delay":1,"name":"example"}]},"dc_cluster_group":{"name":"example","namespace":"example"},"dc_cluster_group_inside":{"name":"example","namespace":"example"},"default_config":{},"default_sriov_interface":{},"default_storage_class":{},"deny_all_usb":{},"device_list":{"devices":[{"name":"example","network_device":{"interface":[{"name":"example","namespace":"example"}],"use":"NETWORK_INTERFACE_USE_REGULAR"},"owner":"DEVICE_OWNER_INVALID"}]},"disable_gpu":{},"disable_vm":{},"enable_default_fleet_config_download":true,"enable_gpu":{},"enable_vgpu":{"feature_type":"UNLICENSED","server_address":"example","server_port":1},"enable_vm":{},"fleet_label":"example","inside_virtual_network":[{"name":"example","namespace":"example"}],"interface_list":{"interfaces":[{"name":"example","namespace":"example"}]},"kubernetes_upgrade_drain":{"disable_upgrade_drain":{},"enable_upgrade_drain":{"disable_vega_upgrade_mode":{},"drain_max_unavailable_node_count":1,"drain_node_timeout":1,"enable_vega_upgrade_mode":{}}},"log_receiver":{"name":"example","namespace":"example"},"logs_streaming_disabled":{},"network_connectors":[{"name":"example","namespace":"example"}],"network_firewall":[{"name":"example","namespace":"example"}],"no_bond_devices":{},"no_dc_cluster_group":{},"no_storage_device":{},"no_storage_interfaces":{},"no_storage_static_routes":{},"operating_system_version":"example","outside_virtual_network":[{"name":"example","namespace":"example"}],"performance_enhancement_mode":{"perf_mode_l3_enhanced":{"jumbo":{},"no_jumbo":{}},"perf_mode_l7_enhanced":{}},"sriov_interfaces":{"sriov_interface":[{"interface_name":"example","number_of_vfio_vfs":1,"number_of_vfs":1}]},"storage_class_list":{"storage_classes":[{"advanced_storage_parameters":{},"allow_volume_expansion":true,"custom_storage":{"yaml":"example"},"default_storage_class":true,"description":"example","hpe_storage":{"allow_mutations":"example","allow_overrides":"example","dedupe_enabled":true,"description":"example","destroy_on_delete":true,"encrypted":true,"folder":"example","limit_iops":"example","limit_mbps":"example","performance_policy":"example","pool":"example","protection_template":"example","secret_name":"example","secret_namespace":"example","sync_on_detach":true,"thick":true},"netapp_trident":{"selector":{},"storage_pools":"example"},"pure_service_orchestrator":{"backend":"example","bandwidth_limit":"example","iops_limit":1},"reclaim_policy":"example","storage_class_name":"example","storage_device":"example"}]},"storage_device_list":{"storage_devices":[{"advanced_advanced_parameters":{},"custom_storage":{},"hpe_storage":{"api_server_port":1,"iscsi_chap_password":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"iscsi_chap_user":"example","password":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"storage_server_ip_address":"example","storage_server_name":"example","username":"example"},"netapp_trident":{"netapp_backend_ontap_nas":{"auto_export_cidrs":{"prefixes":["example"]},"auto_export_policy":true,"backend_name":"example","client_certificate":"example","client_private_key":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"data_lif_dns_name":"example","data_lif_ip":"example","labels":{},"limit_aggregate_usage":"example","limit_volume_size":"example","management_lif_dns_name":"example","management_lif_ip":"example","nfs_mount_options":"example","password":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"region":"example","storage":[{"labels":{},"volume_defaults":{"adaptive_qos_policy":"example","encryption":true,"export_policy":"example","no_qos":{},"qos_policy":"example","security_style":"example","snapshot_dir":true,"snapshot_policy":"example","snapshot_reserve":"example","space_reserve":"example","split_on_clone":true,"tiering_policy":"example","unix_permissions":1},"zone":"example"}],"storage_driver_name":"example","storage_prefix":"example","svm":"example","trusted_ca_certificate":"example","username":"example","volume_defaults":{"adaptive_qos_policy":"example","encryption":true,"export_policy":"example","no_qos":{},"qos_policy":"example","security_style":"example","snapshot_dir":true,"snapshot_policy":"example","snapshot_reserve":"example","space_reserve":"example","split_on_clone":true,"tiering_policy":"example","unix_permissions":1}},"netapp_backend_ontap_san":{"client_certificate":"example","client_private_key":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"data_lif_dns_name":"example","data_lif_ip":"example","igroup_name":"example","labels":{},"limit_aggregate_usage":1,"limit_volume_size":1,"management_lif_dns_name":"example","management_lif_ip":"example","no_chap":{},"password":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"region":"example","storage":[{"labels":{},"volume_defaults":{"adaptive_qos_policy":"example","encryption":true,"export_policy":"example","no_qos":{},"qos_policy":"example","security_style":"example","snapshot_dir":true,"snapshot_policy":"example","snapshot_reserve":"example","space_reserve":"example","split_on_clone":true,"tiering_policy":"example","unix_permissions":1},"zone":"example"}],"storage_driver_name":"example","storage_prefix":"example","svm":"example","trusted_ca_certificate":"example","use_chap":{"chap_initiator_secret":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"chap_target_initiator_secret":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"chap_target_username":"example","chap_username":"example"},"username":"example","volume_defaults":{"adaptive_qos_policy":"example","encryption":true,"export_policy":"example","no_qos":{},"qos_policy":"example","security_style":"example","snapshot_dir":true,"snapshot_policy":"example","snapshot_reserve":"example","space_reserve":"example","split_on_clone":true,"tiering_policy":"example","unix_permissions":1}}},"pure_service_orchestrator":{"arrays":{"flash_array":{"default_fs_opt":"example","default_fs_type":"example","default_mount_opts":["example"],"disable_preempt_attachments":true,"flash_arrays":[{"api_token":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"labels":{},"mgmt_dns_name":"example","mgmt_ip":"example"}],"iscsi_login_timeout":1,"san_type":"example"},"flash_blade":{"enable_snapshot_directory":true,"export_rules":"example","flash_blades":[{"api_token":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"}},"mgmt_dns_name":"example","mgmt_ip":"example","nfs_endpoint_dns_name":"example","nfs_endpoint_ip":"example","labels":{}}]}},"cluster_id":"example","enable_storage_topology":true,"enable_strict_topology":true},"storage_device":"example"}]},"storage_interface_list":{"interfaces":[{"name":"example","namespace":"example"}]},"storage_static_routes":{"storage_routes":[{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]}]},"usb_policy":{"name":"example","namespace":"example"},"volterra_software_version":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/fleets \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "allow_all_usb": {}, "blocked_services": [ { "dns": {}, "network_type": "VIRTUAL_NETWORK_SITE_LOCAL", "ssh": {}, "web_user_interface": {} } ], "bond_device_list": { "bond_devices": [ { "active_backup": {}, "devices": [ "example" ], "lacp": { "rate": 1 }, "link_polling_interval": 1, "link_up_delay": 1, "name": "example" } ] }, "dc_cluster_group": { "name": "example", "namespace": "example" }, "dc_cluster_group_inside": { "name": "example", "namespace": "example" }, "default_config": {}, "default_sriov_interface": {}, "default_storage_class": {}, "deny_all_usb": {}, "device_list": { "devices": [ { "name": "example", "network_device": { "interface": [ { "name": "example", "namespace": "example" } ], "use": "NETWORK_INTERFACE_USE_REGULAR" }, "owner": "DEVICE_OWNER_INVALID" } ] }, "disable_gpu": {}, "disable_vm": {}, "enable_default_fleet_config_download": true, "enable_gpu": {}, "enable_vgpu": { "feature_type": "UNLICENSED", "server_address": "example", "server_port": 1 }, "enable_vm": {}, "fleet_label": "example", "inside_virtual_network": [ { "name": "example", "namespace": "example" } ], "interface_list": { "interfaces": [ { "name": "example", "namespace": "example" } ] }, "kubernetes_upgrade_drain": { "disable_upgrade_drain": {}, "enable_upgrade_drain": { "disable_vega_upgrade_mode": {}, "drain_max_unavailable_node_count": 1, "drain_node_timeout": 1, "enable_vega_upgrade_mode": {} } }, "log_receiver": { "name": "example", "namespace": "example" }, "logs_streaming_disabled": {}, "network_connectors": [ { "name": "example", "namespace": "example" } ], "network_firewall": [ { "name": "example", "namespace": "example" } ], "no_bond_devices": {}, "no_dc_cluster_group": {}, "no_storage_device": {}, "no_storage_interfaces": {}, "no_storage_static_routes": {}, "operating_system_version": "example", "outside_virtual_network": [ { "name": "example", "namespace": "example" } ], "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} }, "sriov_interfaces": { "sriov_interface": [ { "interface_name": "example", "number_of_vfio_vfs": 1, "number_of_vfs": 1 } ] }, "storage_class_list": { "storage_classes": [ { "advanced_storage_parameters": {}, "allow_volume_expansion": true, "custom_storage": { "yaml": "example" }, "default_storage_class": true, "description": "example", "hpe_storage": { "allow_mutations": "example", "allow_overrides": "example", "dedupe_enabled": true, "description": "example", "destroy_on_delete": true, "encrypted": true, "folder": "example", "limit_iops": "example", "limit_mbps": "example", "performance_policy": "example", "pool": "example", "protection_template": "example", "secret_name": "example", "secret_namespace": "example", "sync_on_detach": true, "thick": true }, "netapp_trident": { "selector": {}, "storage_pools": "example" }, "pure_service_orchestrator": { "backend": "example", "bandwidth_limit": "example", "iops_limit": 1 }, "reclaim_policy": "example", "storage_class_name": "example", "storage_device": "example" } ] }, "storage_device_list": { "storage_devices": [ { "advanced_advanced_parameters": {}, "custom_storage": {}, "hpe_storage": { "api_server_port": 1, "iscsi_chap_password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "iscsi_chap_user": "example", "password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "storage_server_ip_address": "example", "storage_server_name": "example", "username": "example" }, "netapp_trident": { "netapp_backend_ontap_nas": { "auto_export_cidrs": { "prefixes": [ "example" ] }, "auto_export_policy": true, "backend_name": "example", "client_certificate": "example", "client_private_key": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "data_lif_dns_name": "example", "data_lif_ip": "example", "labels": {}, "limit_aggregate_usage": "example", "limit_volume_size": "example", "management_lif_dns_name": "example", "management_lif_ip": "example", "nfs_mount_options": "example", "password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "region": "example", "storage": [ { "labels": {}, "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 }, "zone": "example" } ], "storage_driver_name": "example", "storage_prefix": "example", "svm": "example", "trusted_ca_certificate": "example", "username": "example", "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 } }, "netapp_backend_ontap_san": { "client_certificate": "example", "client_private_key": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "data_lif_dns_name": "example", "data_lif_ip": "example", "igroup_name": "example", "labels": {}, "limit_aggregate_usage": 1, "limit_volume_size": 1, "management_lif_dns_name": "example", "management_lif_ip": "example", "no_chap": {}, "password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "region": "example", "storage": [ { "labels": {}, "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 }, "zone": "example" } ], "storage_driver_name": "example", "storage_prefix": "example", "svm": "example", "trusted_ca_certificate": "example", "use_chap": { "chap_initiator_secret": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "chap_target_initiator_secret": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "chap_target_username": "example", "chap_username": "example" }, "username": "example", "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 } } }, "pure_service_orchestrator": { "arrays": { "flash_array": { "default_fs_opt": "example", "default_fs_type": "example", "default_mount_opts": [ "example" ], "disable_preempt_attachments": true, "flash_arrays": [ { "api_token": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "labels": {}, "mgmt_dns_name": "example", "mgmt_ip": "example" } ], "iscsi_login_timeout": 1, "san_type": "example" }, "flash_blade": { "enable_snapshot_directory": true, "export_rules": "example", "flash_blades": [ { "api_token": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "mgmt_dns_name": "example", "mgmt_ip": "example", "nfs_endpoint_dns_name": "example", "nfs_endpoint_ip": "example", "labels": {} } ] } }, "cluster_id": "example", "enable_storage_topology": true, "enable_strict_topology": true }, "storage_device": "example" } ] }, "storage_interface_list": { "interfaces": [ { "name": "example", "namespace": "example" } ] }, "storage_static_routes": { "storage_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] } ] }, "usb_policy": { "name": "example", "namespace": "example" }, "volterra_software_version": "example" } }'Create fleet will create a fleet object in ‘system’ namespace of the user.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace 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 ""
Request Bodyrequired
Section titled “Request Bodyrequired”This is the input message of the ‘Create’ RPC.
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
object
Disable node local services on this site.
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
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
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
Configuration for all devices in the fleet. Examples of devices are - network interfaces, cameras, scanners etc. Configuration a device is applied on VER node if the VER node is member of this fleet and has an corresponding interface/device. The mapping from device configured in fleet with interface/device in VER node depends on the type of device and is documented in device instance specific sections.
Device Instance describes a single device in fleet A device can be of type network interface, camera, scanner etc. A device instance is created for each instance of device. If there are 2 network interfaces(eth0, eth1…), then 2 DeviceInstanceType are created one for eth0 and another for eth1.
object
Name of the device including the unit number (e.g. Eth0 or disk1). The name must match name of device in host-OS of node.
object
Network Interface attributes for the device. User network interface configuration for this network device. Attributes like labels, MTU from the ‘interface’ are applied to corresponding interface in VER node If network interface refers to a virtual-network, the virtual-netowrk type must be consistent with use attribute given below If use is NETWORK_INTERFACE_USE_REGULAR, the virtual-network must be of type VIRTUAL_NETWORK_SITE_LOCAL or VIRTUAL_NETWORK_SITE_LOCAL_INSIDE if use is NETWORK_INTERFACE_USE_OUTSIDE, the virtual-network must of type VIRTUAL_NETWORK_SITE_LOCAL if use is NETWORK_INTERFACE_USE_INSIDE, the virtual-network must of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE
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
Enable default fleet config, It must be set for storage config and GPU config.
object
object
Set License Server Address.
Set License Server port number.
object
Fleet_label value is used to create known_label “F5 XC/fleet=<fleet_label>” The known_label is created in the “shared” namespace for the tenant.
A virtual_site object with name <fleet_label> is also created in “shared” namespace for tenant. The virtual_site object will select all sites configured with the known_label above fleet_label with “sfo” will create a known_label “F5 XC/fleet=sfo” in tenant for the fleet Required: YES.
Default inside (site local) virtual network for the fleet.
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
Add all interfaces belonging to this fleet
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
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
Network Connector defines connection between two virtual networks in a given site. Fleet defines one or more such network connectors. The network connectors configuration is applied on all sites that are member of the fleet.
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.
Network Firewall defines firewall to be applied for the virtual networks in the fleet. The network firewall configuration is applied on all sites that are member of the fleet.
Constraints The Network Firewall is applied on Virtual Networks of type site local network and site local inside network.
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
object
object
object
Desired Operating System version that is applied to all sites that are member of the fleet. Current Operating System version can be overridden via site config.
Default outside (site local) virtual network for the fleet.
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
object
object
object
object
Use custom SR-IOV interfaces Configuration.
Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.
object
Name of SR-IOV physical interface Required: YES.
Number of virtual functions reserved for VNFs and DPDK-based CNFs.
Total number of virtual functions Required: YES.
object
List of custom storage classes.
Configuration of custom storage class.
object
Map of parameter name and string value.
object
Allow volume expansion.
object
K8s YAML for StorageClass.
Make this storage class default storage class for the K8s cluster.
Description for this storage class.
object
Mutation can override specified parameters.
PVC can override specified parameters.
Indicates that the volume should enable deduplication.
The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.
Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.
Indicates that the volume should be encrypted.
The name of the folder in which to place the volume.
The IOPS limit of the volume.
The IOPS limit of the volume.
The name of the performance policy to assign to the volume.
The name of the pool in which to place the volume.
The name of the performance policy to assign to the volume.
The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.
The SecretNamespace parameter is used to identify name of namespace where secret resides.
Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.
Indicates that the volume should be thick provisioned.
object
Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume. The volume will have the aspects defined in the chosen virtual pool.
object
The storagePools parameter is used to further restrict the set of pools that match any specified attributes.
object
Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.
It must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes must be multiple of 512) or number with a single character unit symbol. Valid unit symbols are K, M, G, representing KiB, MiB, and GiB.
Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.
Reclaim Policy.
Name of the storage class as it will appear in K8s. Required: YES.
Storage device that this class will use. The Device name defined at previous step. Required: YES.
object
List of custom storage devices.
Configuration of storage device.
object
Map of parameter name and string value.
object
object
object
Enter Storage Server Port.
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.
Chap Username to connect to the HPE storage.
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.
Enter storage server IP address.
Enter storage server Name.
Username to connect to the HPE storage management IP Required: YES.
object
object
object
List of IPv4 prefixes that represent an endpoint.
Enable automatic export policy creation and updating.
Configuration of Backend Name. Driver is name + ”_” + dataLIF.
Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.
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.
Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.
object
Fail provisioning if usage is above this percentage. Not enforced by default.
Fail provisioning if requested volume size is above this value. Not enforced by default.
Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.
Comma-separated list of NFS mount OPTIONS. Not enforced by default.
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.
Virtual Pool Region.
List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.
ONTAP Virtual Storage Pool definition.
object
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.
object
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
Virtual Storage Pool zone definition.
Configuration of Backend Name Required: YES.
Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.
Storage virtual machine to use. Derived if an SVM managementLIF is specified.
Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..
Username to connect to the cluster/SVM Required: YES.
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
object
Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.
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.
Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.
Name of the igroup for SAN volumes to use.
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.
object
Fail provisioning if usage is above this percentage. Not enforced by default.
Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.
Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.
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.
Virtual Pool Region.
List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.
ONTAP Virtual Storage Pool definition.
object
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.
object
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
Virtual Storage Pool zone definition.
Configuration of Backend Name Required: YES.
Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.
Storage virtual machine to use. Derived if an SVM managementLIF is specified.
Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..
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
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.
Target username. Required if useCHAP=true.
Inbound username. Required if useCHAP=true.
Username to connect to the cluster/SVM Required: YES.
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
object
object
object
Block volume default mkfs OPTIONS. Not recommended to change!
Block volume default filesystem type. Not recommended to change! Required: YES.
Block volume default filesystem mount OPTIONS. Not recommended to change!
Enable/Disable attachment preemption!
For FlashArrays you must set the “mgmt_endpoint” and “api_token”
Required: YES.
For FlashArrays you must set the “mgmt_endpoint” and “api_token”
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.
The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.
object
Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.
ISCSI login timeout in seconds. Not recommended to change! Required: YES.
Block volume access protocol, either ISCSI or FC Required: YES.
object
Enable/Disable FlashBlade snapshots.
NFS Export rules.
For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint
Required: YES.
For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint.
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.
Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.
Exclusive with [nfs_endpoint_ip] Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [nfs_endpoint_dns_name] Endpoint is reachable at the given IP address.
The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.
object
ClusterID is added as a prefix for all volumes created by this PSO installation. ClusterID is also used to identify the volumes used by the datastore, pso-db. ClusterID MUST BE UNIQUE for multiple K8s clusters running on top of the same storage arrays. Characters allowed: alphanumeric and underscores Required: YES.
This option is to enable/disable the csi topology feature for pso-csi.
This option is to enable/disable the strict csi topology feature for pso-csi.
Storage device and device unit Required: YES.
object
Add all interfaces belonging to this fleet
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
List of storage 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 route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
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
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
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
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.
F5XC software version is human readable string matching released set of version components. The given software version is applied to all sites that are member of the fleet. Current software installed can be overridden via site config.
Responses
Section titled “Responses”A successful response.
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
object
Disable node local services on this site.
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
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
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
Configuration for all devices in the fleet. Examples of devices are - network interfaces, cameras, scanners etc. Configuration a device is applied on VER node if the VER node is member of this fleet and has an corresponding interface/device. The mapping from device configured in fleet with interface/device in VER node depends on the type of device and is documented in device instance specific sections.
Device Instance describes a single device in fleet A device can be of type network interface, camera, scanner etc. A device instance is created for each instance of device. If there are 2 network interfaces(eth0, eth1…), then 2 DeviceInstanceType are created one for eth0 and another for eth1.
object
Name of the device including the unit number (e.g. Eth0 or disk1). The name must match name of device in host-OS of node.
object
Network Interface attributes for the device. User network interface configuration for this network device. Attributes like labels, MTU from the ‘interface’ are applied to corresponding interface in VER node If network interface refers to a virtual-network, the virtual-netowrk type must be consistent with use attribute given below If use is NETWORK_INTERFACE_USE_REGULAR, the virtual-network must be of type VIRTUAL_NETWORK_SITE_LOCAL or VIRTUAL_NETWORK_SITE_LOCAL_INSIDE if use is NETWORK_INTERFACE_USE_OUTSIDE, the virtual-network must of type VIRTUAL_NETWORK_SITE_LOCAL if use is NETWORK_INTERFACE_USE_INSIDE, the virtual-network must of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE
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
Enable default fleet config, It must be set for storage config and GPU config.
object
object
Set License Server Address.
Set License Server port number.
object
Fleet_label value is used to create known_label “F5 XC/fleet=<fleet_label>” The known_label is created in the “shared” namespace for the tenant.
A virtual_site object with name <fleet_label> is also created in “shared” namespace for tenant. The virtual_site object will select all sites configured with the known_label above fleet_label with “sfo” will create a known_label “F5 XC/fleet=sfo” in tenant for the fleet Required: YES.
Default inside (site local) virtual network for the fleet.
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
Add all interfaces belonging to this fleet
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
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
Network Connector defines connection between two virtual networks in a given site. Fleet defines one or more such network connectors. The network connectors configuration is applied on all sites that are member of the fleet.
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.
Network Firewall defines firewall to be applied for the virtual networks in the fleet. The network firewall configuration is applied on all sites that are member of the fleet.
Constraints The Network Firewall is applied on Virtual Networks of type site local network and site local inside network.
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
object
object
object
Desired Operating System version that is applied to all sites that are member of the fleet. Current Operating System version can be overridden via site config.
Default outside (site local) virtual network for the fleet.
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
object
object
object
object
Use custom SR-IOV interfaces Configuration.
Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.
object
Name of SR-IOV physical interface Required: YES.
Number of virtual functions reserved for VNFs and DPDK-based CNFs.
Total number of virtual functions Required: YES.
object
List of custom storage classes.
Configuration of custom storage class.
object
Map of parameter name and string value.
object
Allow volume expansion.
object
K8s YAML for StorageClass.
Make this storage class default storage class for the K8s cluster.
Description for this storage class.
object
Mutation can override specified parameters.
PVC can override specified parameters.
Indicates that the volume should enable deduplication.
The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.
Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.
Indicates that the volume should be encrypted.
The name of the folder in which to place the volume.
The IOPS limit of the volume.
The IOPS limit of the volume.
The name of the performance policy to assign to the volume.
The name of the pool in which to place the volume.
The name of the performance policy to assign to the volume.
The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.
The SecretNamespace parameter is used to identify name of namespace where secret resides.
Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.
Indicates that the volume should be thick provisioned.
object
Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume. The volume will have the aspects defined in the chosen virtual pool.
object
The storagePools parameter is used to further restrict the set of pools that match any specified attributes.
object
Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.
It must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes must be multiple of 512) or number with a single character unit symbol. Valid unit symbols are K, M, G, representing KiB, MiB, and GiB.
Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.
Reclaim Policy.
Name of the storage class as it will appear in K8s. Required: YES.
Storage device that this class will use. The Device name defined at previous step. Required: YES.
object
List of custom storage devices.
Configuration of storage device.
object
Map of parameter name and string value.
object
object
object
Enter Storage Server Port.
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.
Chap Username to connect to the HPE storage.
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.
Enter storage server IP address.
Enter storage server Name.
Username to connect to the HPE storage management IP Required: YES.
object
object
object
List of IPv4 prefixes that represent an endpoint.
Enable automatic export policy creation and updating.
Configuration of Backend Name. Driver is name + ”_” + dataLIF.
Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.
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.
Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.
object
Fail provisioning if usage is above this percentage. Not enforced by default.
Fail provisioning if requested volume size is above this value. Not enforced by default.
Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.
Comma-separated list of NFS mount OPTIONS. Not enforced by default.
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.
Virtual Pool Region.
List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.
ONTAP Virtual Storage Pool definition.
object
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.
object
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
Virtual Storage Pool zone definition.
Configuration of Backend Name Required: YES.
Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.
Storage virtual machine to use. Derived if an SVM managementLIF is specified.
Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..
Username to connect to the cluster/SVM Required: YES.
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
object
Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.
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.
Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.
Name of the igroup for SAN volumes to use.
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.
object
Fail provisioning if usage is above this percentage. Not enforced by default.
Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.
Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.
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.
Virtual Pool Region.
List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.
ONTAP Virtual Storage Pool definition.
object
List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.
object
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
Virtual Storage Pool zone definition.
Configuration of Backend Name Required: YES.
Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.
Storage virtual machine to use. Derived if an SVM managementLIF is specified.
Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..
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
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.
Target username. Required if useCHAP=true.
Inbound username. Required if useCHAP=true.
Username to connect to the cluster/SVM Required: YES.
object
Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.
Enable NetApp volume encryption.
Export policy to use.
object
Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.
Security style for new volumes.
Access to the .snapshot directory.
Snapshot policy to use.
Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""
Space reservation mode; “none” (thin) or “volume” (thick)
Split a clone from its parent upon creation.
Tiering policy to use. “none” is default.
Unix permission mode for new volumes. All allowed 777.
object
object
object
Block volume default mkfs OPTIONS. Not recommended to change!
Block volume default filesystem type. Not recommended to change! Required: YES.
Block volume default filesystem mount OPTIONS. Not recommended to change!
Enable/Disable attachment preemption!
For FlashArrays you must set the “mgmt_endpoint” and “api_token”
Required: YES.
For FlashArrays you must set the “mgmt_endpoint” and “api_token”
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.
The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.
object
Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.
ISCSI login timeout in seconds. Not recommended to change! Required: YES.
Block volume access protocol, either ISCSI or FC Required: YES.
object
Enable/Disable FlashBlade snapshots.
NFS Export rules.
For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint
Required: YES.
For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint.
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.
Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.
Exclusive with [nfs_endpoint_ip] Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.
Exclusive with [nfs_endpoint_dns_name] Endpoint is reachable at the given IP address.
The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.
object
ClusterID is added as a prefix for all volumes created by this PSO installation. ClusterID is also used to identify the volumes used by the datastore, pso-db. ClusterID MUST BE UNIQUE for multiple K8s clusters running on top of the same storage arrays. Characters allowed: alphanumeric and underscores Required: YES.
This option is to enable/disable the csi topology feature for pso-csi.
This option is to enable/disable the strict csi topology feature for pso-csi.
Storage device and device unit Required: YES.
object
Add all interfaces belonging to this fleet
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
List of storage 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 route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
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
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
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
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.
F5XC software version is human readable string matching released set of version components. The given software version is applied to all sites that are member of the fleet. Current software installed can be overridden via site config.
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
{ "spec": { "blocked_services": [ { "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } ], "device_list": { "devices": [ { "network_device": { "use": "NETWORK_INTERFACE_USE_REGULAR" }, "owner": "DEVICE_OWNER_INVALID" } ] }, "enable_vgpu": { "feature_type": "UNLICENSED" }, "storage_static_routes": { "storage_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } ] } }}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