- Home
- API Enriched
- Sites
- config
- Replace App Stack site.
Replace App Stack site.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/voltstack_sites/example';const options = { method: 'PUT', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"metadata":{"annotations":{},"description":"example","disable":true,"labels":{},"name":"example","namespace":"example"},"spec":{"address":"example","allow_all_usb":{},"blocked_services":{"blocked_sevice":[{"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"}]},"coordinates":{"latitude":1,"longitude":1},"custom_dns":{"inside_nameserver":"example","outside_nameserver":"example"},"custom_network_config":{"active_enhanced_firewall_policies":{"enhanced_firewall_policies":[{"name":"example","namespace":"example"}]},"active_forward_proxy_policies":{"forward_proxy_policies":[{"name":"example","namespace":"example"}]},"active_network_policies":{"network_policies":[{"name":"example","namespace":"example"}]},"bgp_peer_address":"example","bgp_router_id":"example","default_config":{},"default_interface_config":{},"default_sli_config":{},"forward_proxy_allow_all":{},"global_network_list":{"global_network_connections":[{"sli_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}},"slo_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}}}]},"interface_list":{"interfaces":[{"dc_cluster_group_connectivity_interface_disabled":{},"dc_cluster_group_connectivity_interface_enabled":{},"dedicated_interface":{"cluster":{},"device":"example","is_primary":{},"monitor":{},"monitor_disabled":{},"mtu":1,"node":"example","not_primary":{},"priority":1},"dedicated_management_interface":{"cluster":{},"device":"example","mtu":1,"node":"example"},"description":"example","ethernet_interface":{"cluster":{},"device":"example","dhcp_client":{},"dhcp_server":{"automatic_from_end":{},"automatic_from_start":{},"dhcp_networks":[{"dgw_address":"example","dns_address":"example","first_address":{},"last_address":{},"network_prefix":"example","pool_settings":"INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS","pools":[{"end_ip":"example","start_ip":"example","exclude":true}],"same_as_dgw":{},"network_prefix_allocator":{"name":"example","namespace":"example"}}],"fixed_ip_map":{},"interface_ip_map":{"interface_ip_map":{}}},"ipv6_auto_config":{"host":{},"router":{"dns_config":{"configured_list":{"dns_list":["example"]},"local_dns":{"configured_address":"example","first_address":{},"last_address":{}}},"network_prefix":"example","stateful":{"automatic_from_end":{},"automatic_from_start":{},"dhcp_networks":[{"network_prefix":"example","pool_settings":"INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS","pools":[{"end_ip":"example","start_ip":"example"}]}],"fixed_ip_map":{},"interface_ip_map":{"interface_ip_map":{}}}}},"is_primary":{},"monitor":{},"monitor_disabled":{},"mtu":1,"no_ipv6_address":{},"node":"example","not_primary":{},"priority":1,"site_local_inside_network":{},"site_local_network":{},"static_ip":{"cluster_static_ip":{"interface_ip_map":{}},"node_static_ip":{"default_gw":"example","ip_address":"example"}},"static_ipv6_address":{"cluster_static_ip":{"interface_ip_map":{}},"node_static_ip":{"default_gw":"example","ip_address":"example"}},"storage_network":{},"untagged":{},"vlan_id":1},"labels":{},"tunnel_interface":{"mtu":1,"node":"example","priority":1,"site_local_inside_network":{},"site_local_network":{},"static_ip":{"cluster_static_ip":{"interface_ip_map":{}},"node_static_ip":{"default_gw":"example","ip_address":"example"}},"tunnel":{"name":"example","namespace":"example"}}}]},"no_forward_proxy":{},"no_global_network":{},"no_network_policy":{},"outside_nameserver":"example","outside_vip":"example","site_to_site_tunnel_ip":"example","sli_config":{"no_static_routes":{},"no_v6_static_routes":{},"static_routes":{"static_routes":[{"attrs":["ROUTE_ATTR_NO_OP"],"default_gateway":{},"ip_address":"example","ip_prefixes":["example"],"node_interface":{"list":[{"interface":[{"name":"example","namespace":"example"}],"node":"example"}]}}]},"static_v6_routes":{"static_routes":[{"attrs":["ROUTE_ATTR_NO_OP"],"default_gateway":{},"ip_address":"example","ip_prefixes":["example"],"node_interface":{"list":[{"interface":[{"name":"example","namespace":"example"}],"node":"example"}]}}]}},"slo_config":{"dc_cluster_group":{"name":"example","namespace":"example"},"labels":{},"no_dc_cluster_group":{},"no_static_routes":{},"no_static_v6_routes":{},"static_routes":{"static_routes":[{"attrs":["ROUTE_ATTR_NO_OP"],"default_gateway":{},"ip_address":"example","ip_prefixes":["example"],"node_interface":{"list":[{"interface":[{"name":"example","namespace":"example"}],"node":"example"}]}}]},"static_v6_routes":{"static_routes":[{"attrs":["ROUTE_ATTR_NO_OP"],"default_gateway":{},"ip_address":"example","ip_prefixes":["example"],"node_interface":{"list":[{"interface":[{"name":"example","namespace":"example"}],"node":"example"}]}}]}},"sm_connection_public_ip":{},"sm_connection_pvt_ip":{},"tunnel_dead_timeout":1,"vip_vrrp_mode":"VIP_VRRP_INVALID"},"custom_storage_config":{"default_storage_class":{},"no_static_routes":{},"no_storage_device":{},"no_storage_interfaces":{},"static_routes":{"static_routes":[{"attrs":["ROUTE_ATTR_NO_OP"],"default_gateway":{},"ip_address":"example","ip_prefixes":["example"],"node_interface":{"list":[{"interface":[{"name":"example","namespace":"example"}],"node":"example"}]}}]},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"chap_target_initiator_secret":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"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":{"storage_interfaces":[{"description":"example","labels":{},"storage_interface":{"cluster":{},"device":"example","dhcp_client":{},"dhcp_server":{"automatic_from_end":{},"automatic_from_start":{},"dhcp_networks":[{"dgw_address":"example","dns_address":"example","first_address":{},"last_address":{},"network_prefix":"example","pool_settings":"INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS","pools":[{"end_ip":"example","start_ip":"example","exclude":true}],"same_as_dgw":{},"network_prefix_allocator":{"name":"example","namespace":"example"}}],"fixed_ip_map":{},"interface_ip_map":{"interface_ip_map":{}}},"ipv6_auto_config":{"host":{},"router":{"dns_config":{"configured_list":{"dns_list":["example"]},"local_dns":{"configured_address":"example","first_address":{},"last_address":{}}},"network_prefix":"example","stateful":{"automatic_from_end":{},"automatic_from_start":{},"dhcp_networks":[{"network_prefix":"example","pool_settings":"INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS","pools":[{"end_ip":"example","start_ip":"example"}]}],"fixed_ip_map":{},"interface_ip_map":{"interface_ip_map":{}}}}},"is_primary":{},"monitor":{},"monitor_disabled":{},"mtu":1,"no_ipv6_address":{},"node":"example","not_primary":{},"priority":1,"site_local_inside_network":{},"site_local_network":{},"static_ip":{"cluster_static_ip":{"interface_ip_map":{}},"node_static_ip":{"default_gw":"example","ip_address":"example"}},"static_ipv6_address":{"cluster_static_ip":{"interface_ip_map":{}},"node_static_ip":{"default_gw":"example","ip_address":"example"}},"storage_network":{},"untagged":{},"vlan_id":1}}]}},"default_blocked_services":{},"default_network_config":{},"default_sriov_interface":{},"default_storage_config":{},"deny_all_usb":{},"disable_gpu":{},"disable_vm":{},"enable_gpu":{},"enable_vgpu":{"feature_type":"UNLICENSED","server_address":"example","server_port":1},"enable_vm":{},"k8s_cluster":{"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":{}}},"local_control_plane":{"bgp_config":{"asn":1,"peers":[{"bfd_disabled":{},"bfd_enabled":{"multiplier":1,"receive_interval_milliseconds":1,"transmit_interval_milliseconds":1},"disable":{},"external":{"address":"example","address_ipv6":"example","asn":1,"default_gateway":{},"default_gateway_v6":{},"disable":{},"disable_v6":{},"external_connector":{},"family_inet":{"disable":{},"enable":{}},"from_site":{},"from_site_v6":{},"interface":{"name":"example","namespace":"example"},"interface_list":{"interfaces":[{"name":"example","namespace":"example"}]},"md5_auth_key":"example","no_authentication":{},"port":1,"subnet_begin_offset":1,"subnet_begin_offset_v6":1,"subnet_end_offset":1,"subnet_end_offset_v6":1},"label":"example","metadata":{"description":"example","name":"example"},"passive_mode_disabled":{},"passive_mode_enabled":{},"routing_policies":{"route_policy":[{"all_nodes":{},"inbound":{},"node_name":{"node":["example"]},"object_refs":[{"name":"example","namespace":"example"}],"outbound":{}}]}}]},"inside_vn":{},"outside_vn":{}},"log_receiver":{"name":"example","namespace":"example"},"logs_streaming_disabled":{},"master_node_configuration":[{"name":"example","public_ip":"example"}],"no_bond_devices":{},"no_k8s_cluster":{},"no_local_control_plane":{},"offline_survivability_mode":{"enable_offline_survivability_mode":{},"no_offline_survivability_mode":{}},"os":{"default_os_version":{},"operating_system_version":"example"},"sriov_interfaces":{"sriov_interface":[{"interface_name":"example","number_of_vfio_vfs":1,"number_of_vfs":1}]},"sw":{"default_sw_version":{},"volterra_software_version":"example"},"usb_policy":{"name":"example","namespace":"example"},"volterra_certified_hw":"example","worker_nodes":["example"]}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/voltstack_sites/example \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "address": "example", "allow_all_usb": {}, "blocked_services": { "blocked_sevice": [ { "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" } ] }, "coordinates": { "latitude": 1, "longitude": 1 }, "custom_dns": { "inside_nameserver": "example", "outside_nameserver": "example" }, "custom_network_config": { "active_enhanced_firewall_policies": { "enhanced_firewall_policies": [ { "name": "example", "namespace": "example" } ] }, "active_forward_proxy_policies": { "forward_proxy_policies": [ { "name": "example", "namespace": "example" } ] }, "active_network_policies": { "network_policies": [ { "name": "example", "namespace": "example" } ] }, "bgp_peer_address": "example", "bgp_router_id": "example", "default_config": {}, "default_interface_config": {}, "default_sli_config": {}, "forward_proxy_allow_all": {}, "global_network_list": { "global_network_connections": [ { "sli_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } }, "slo_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } } } ] }, "interface_list": { "interfaces": [ { "dc_cluster_group_connectivity_interface_disabled": {}, "dc_cluster_group_connectivity_interface_enabled": {}, "dedicated_interface": { "cluster": {}, "device": "example", "is_primary": {}, "monitor": {}, "monitor_disabled": {}, "mtu": 1, "node": "example", "not_primary": {}, "priority": 1 }, "dedicated_management_interface": { "cluster": {}, "device": "example", "mtu": 1, "node": "example" }, "description": "example", "ethernet_interface": { "cluster": {}, "device": "example", "dhcp_client": {}, "dhcp_server": { "automatic_from_end": {}, "automatic_from_start": {}, "dhcp_networks": [ { "dgw_address": "example", "dns_address": "example", "first_address": {}, "last_address": {}, "network_prefix": "example", "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "pools": [ { "end_ip": "example", "start_ip": "example", "exclude": true } ], "same_as_dgw": {}, "network_prefix_allocator": { "name": "example", "namespace": "example" } } ], "fixed_ip_map": {}, "interface_ip_map": { "interface_ip_map": {} } }, "ipv6_auto_config": { "host": {}, "router": { "dns_config": { "configured_list": { "dns_list": [ "example" ] }, "local_dns": { "configured_address": "example", "first_address": {}, "last_address": {} } }, "network_prefix": "example", "stateful": { "automatic_from_end": {}, "automatic_from_start": {}, "dhcp_networks": [ { "network_prefix": "example", "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "pools": [ { "end_ip": "example", "start_ip": "example" } ] } ], "fixed_ip_map": {}, "interface_ip_map": { "interface_ip_map": {} } } } }, "is_primary": {}, "monitor": {}, "monitor_disabled": {}, "mtu": 1, "no_ipv6_address": {}, "node": "example", "not_primary": {}, "priority": 1, "site_local_inside_network": {}, "site_local_network": {}, "static_ip": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "static_ipv6_address": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "storage_network": {}, "untagged": {}, "vlan_id": 1 }, "labels": {}, "tunnel_interface": { "mtu": 1, "node": "example", "priority": 1, "site_local_inside_network": {}, "site_local_network": {}, "static_ip": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "tunnel": { "name": "example", "namespace": "example" } } } ] }, "no_forward_proxy": {}, "no_global_network": {}, "no_network_policy": {}, "outside_nameserver": "example", "outside_vip": "example", "site_to_site_tunnel_ip": "example", "sli_config": { "no_static_routes": {}, "no_v6_static_routes": {}, "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] } }, "slo_config": { "dc_cluster_group": { "name": "example", "namespace": "example" }, "labels": {}, "no_dc_cluster_group": {}, "no_static_routes": {}, "no_static_v6_routes": {}, "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] } }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {}, "tunnel_dead_timeout": 1, "vip_vrrp_mode": "VIP_VRRP_INVALID" }, "custom_storage_config": { "default_storage_class": {}, "no_static_routes": {}, "no_storage_device": {}, "no_storage_interfaces": {}, "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "chap_target_initiator_secret": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "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": { "storage_interfaces": [ { "description": "example", "labels": {}, "storage_interface": { "cluster": {}, "device": "example", "dhcp_client": {}, "dhcp_server": { "automatic_from_end": {}, "automatic_from_start": {}, "dhcp_networks": [ { "dgw_address": "example", "dns_address": "example", "first_address": {}, "last_address": {}, "network_prefix": "example", "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "pools": [ { "end_ip": "example", "start_ip": "example", "exclude": true } ], "same_as_dgw": {}, "network_prefix_allocator": { "name": "example", "namespace": "example" } } ], "fixed_ip_map": {}, "interface_ip_map": { "interface_ip_map": {} } }, "ipv6_auto_config": { "host": {}, "router": { "dns_config": { "configured_list": { "dns_list": [ "example" ] }, "local_dns": { "configured_address": "example", "first_address": {}, "last_address": {} } }, "network_prefix": "example", "stateful": { "automatic_from_end": {}, "automatic_from_start": {}, "dhcp_networks": [ { "network_prefix": "example", "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "pools": [ { "end_ip": "example", "start_ip": "example" } ] } ], "fixed_ip_map": {}, "interface_ip_map": { "interface_ip_map": {} } } } }, "is_primary": {}, "monitor": {}, "monitor_disabled": {}, "mtu": 1, "no_ipv6_address": {}, "node": "example", "not_primary": {}, "priority": 1, "site_local_inside_network": {}, "site_local_network": {}, "static_ip": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "static_ipv6_address": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "storage_network": {}, "untagged": {}, "vlan_id": 1 } } ] } }, "default_blocked_services": {}, "default_network_config": {}, "default_sriov_interface": {}, "default_storage_config": {}, "deny_all_usb": {}, "disable_gpu": {}, "disable_vm": {}, "enable_gpu": {}, "enable_vgpu": { "feature_type": "UNLICENSED", "server_address": "example", "server_port": 1 }, "enable_vm": {}, "k8s_cluster": { "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": {} } }, "local_control_plane": { "bgp_config": { "asn": 1, "peers": [ { "bfd_disabled": {}, "bfd_enabled": { "multiplier": 1, "receive_interval_milliseconds": 1, "transmit_interval_milliseconds": 1 }, "disable": {}, "external": { "address": "example", "address_ipv6": "example", "asn": 1, "default_gateway": {}, "default_gateway_v6": {}, "disable": {}, "disable_v6": {}, "external_connector": {}, "family_inet": { "disable": {}, "enable": {} }, "from_site": {}, "from_site_v6": {}, "interface": { "name": "example", "namespace": "example" }, "interface_list": { "interfaces": [ { "name": "example", "namespace": "example" } ] }, "md5_auth_key": "example", "no_authentication": {}, "port": 1, "subnet_begin_offset": 1, "subnet_begin_offset_v6": 1, "subnet_end_offset": 1, "subnet_end_offset_v6": 1 }, "label": "example", "metadata": { "description": "example", "name": "example" }, "passive_mode_disabled": {}, "passive_mode_enabled": {}, "routing_policies": { "route_policy": [ { "all_nodes": {}, "inbound": {}, "node_name": { "node": [ "example" ] }, "object_refs": [ { "name": "example", "namespace": "example" } ], "outbound": {} } ] } } ] }, "inside_vn": {}, "outside_vn": {} }, "log_receiver": { "name": "example", "namespace": "example" }, "logs_streaming_disabled": {}, "master_node_configuration": [ { "name": "example", "public_ip": "example" } ], "no_bond_devices": {}, "no_k8s_cluster": {}, "no_local_control_plane": {}, "offline_survivability_mode": { "enable_offline_survivability_mode": {}, "no_offline_survivability_mode": {} }, "os": { "default_os_version": {}, "operating_system_version": "example" }, "sriov_interfaces": { "sriov_interface": [ { "interface_name": "example", "number_of_vfio_vfs": 1, "number_of_vfs": 1 } ] }, "sw": { "default_sw_version": {}, "volterra_software_version": "example" }, "usb_policy": { "name": "example", "namespace": "example" }, "volterra_certified_hw": "example", "worker_nodes": [ "example" ] } }'Shape of the App Stack site replace specification.
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 ""
Name The configuration object to be replaced will be looked up by name.
Request Bodyrequired
Section titled “Request Bodyrequired”This is the input message of the ‘Replace’ 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
Site’s geographical address that can be used to determine its latitude and longitude.
object
object
Blocking or denial configuration
Disable a node local service on this site.
object
object
object
object
object
List of bond devices
Required: YES.
Bond devices configuration for fleet.
object
object
Ethernet devices that will make up this bond Required: YES.
object
Interval in seconds to transmit LACP packets.
Link polling interval in milliseconds Required: YES.
Milliseconds wait before link is declared up Required: YES.
Name for the Bond. Ex ‘bond0’ Required: YES.
object
Latitude of the site location.
Longitude of site location.
object
Optional DNS server IP to be used for name resolution in inside network.
Optional DNS server IP to be used for name resolution in outside network.
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.
Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.
object
object
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Configure network interfaces for this App Stack site
Required: YES.
Interface definition.
object
object
object
object
object
Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
Name of the device for which interface is configured Required: YES.
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [cluster] Configuration will apply to a device on the given node of the site.
Description for this Interface.
object
object
Interface configuration for the ethernet device Required: YES.
object
object
object
object
List of networks from which DHCP Server can allocate IPv4 Addresses
Required: YES.
DHCP network configuration.
object
Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.
Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.
object
object
Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.
List of non overlapping IP address ranges.
DHCP pool is a range of IP addresses (start IP and end IP).
object
Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.
Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.
X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.
object
object
Specify static IPv4 addresses per site:node.
object
object
object
object
object
object
List of IPv6 Addresses acting as DNS servers Required: YES.
object
Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.
object
object
Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.
object
object
object
List of networks from which DHCP server can allocate IP addresses
Required: YES.
DHCP IPv6 network type configuration.
object
Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.
List of non overlapping IP address ranges.
DHCP IPv6 pool is a range of IP addresses (start IP and end IP).
object
Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.
Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.
Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.
object
object
Map of Site:Node to IPv6 address.
object
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
object
Exclusive with [cluster] Configuration will apply to a device on the given node.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Exclusive with [untagged] Configure a VLAN tagged ethernet interface.
Add Labels for this Interface, these labels can be used in firewall policy.
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
Exclusive with [] Configuration will apply to a given device on the given node.
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
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
Optional DNS server V4 IP to be used for name resolution in local network.
Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.
Exclusive with [sm_connection_public_ip sm_connection_pvt_ip] Site Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for creating IPsec between two sites which are part of the site mesh group.
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Node name on this site.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Add Labels for this network, these labels can be used in firewall policy.
object
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Node name on this site.
object
List of IPv6 static routes
Required: YES.
Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of IPv6 route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Node name on this site.
object
object
Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.
object
object
object
object
object
object
List of static routes
Required: YES.
Defines a static route, configuring a list of prefixes and a next-hop to be used for them.
object
List of attributes that control forwarding, dynamic routing and control plane (host) reachability.
object
Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.
List of route prefixes that have common next hop and attributes Required: YES.
object
On a multinode site, this list holds the nodes and corresponding networking_interface.
On a multinode site, this list holds the nodes and corresponding tunnel transport interface.
object
Interface reference on this node.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Node name on this site.
object
List of 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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
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
Configure storage interfaces for this App Stack site
Required: YES.
Configure storage interface for this App Stack site.
object
Description for this Interface.
Add Labels for this Interface, these labels can be used in firewall policy.
object
object
object
Interface configuration for the ethernet device Required: YES.
object
object
object
object
List of networks from which DHCP Server can allocate IPv4 Addresses
Required: YES.
DHCP network configuration.
object
Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.
Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.
object
object
Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.
List of non overlapping IP address ranges.
DHCP pool is a range of IP addresses (start IP and end IP).
object
Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.
Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.
X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.
object
object
Specify static IPv4 addresses per site:node.
object
object
object
object
object
object
List of IPv6 Addresses acting as DNS servers Required: YES.
object
Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.
object
object
Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.
object
object
object
List of networks from which DHCP server can allocate IP addresses
Required: YES.
DHCP IPv6 network type configuration.
object
Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.
List of non overlapping IP address ranges.
DHCP IPv6 pool is a range of IP addresses (start IP and end IP).
object
Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.
Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.
Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.
object
object
Map of Site:Node to IPv6 address.
object
object
object
object
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.
object
Exclusive with [cluster] Configuration will apply to a device on the given node.
object
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.
object
object
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Map of Node to Static IP configuration value, Key:Node, Value:IP Address.
object
object
IP address of the default gateway.
IP address of the interface and prefix length Required: YES.
object
object
Exclusive with [untagged] Configure a VLAN tagged ethernet interface.
object
object
object
object
object
object
object
object
object
Set License Server Address.
Set License Server port number.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
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
object
Autonomous System Number Required: YES.
BGP parameters for peer.
BGP Peer parameters.
object
object
object
Specify Number of missed packets to bring session down” Required: YES.
BFD receive interval timer, in milliseconds Required: YES.
BFD transmit interval timer, in milliseconds Required: YES.
object
object
Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset] Specify IPv4 peer address.
Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6] Specify peer IPv6 address.
Autonomous System Number for BGP peer Required: YES.
object
object
object
object
object
object
object
object
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
List of network interfaces.
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.
Exclusive with [no_authentication] MD5 key for protecting BGP Sessions (RFC 2385)
object
Peer TCP port number.
Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset] Calculate peer address using offset from the beginning of the subnet.
Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6] Calculate peer address using offset from the beginning of the subnet.
Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset] Calculate peer address using offset from the end of the subnet.
Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6] Calculate peer address using offset from the end of the subnet.
Specify whether this peer should be.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Route policy to be applied.
List of filter rules which can be applied on all or particular nodes.
object
object
object
object
Select BGP Session on which policy will be applied.
Select route policy to apply.
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
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Configuration of master nodes
Required: YES.
Master Node is the configuration of the master node.
object
Names of master node Required: YES.
IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.
object
object
object
object
object
object
object
object
Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.
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
object
Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.
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.
Name for generic server certified hardware to form this App Stack site. Required: YES.
Names of worker nodes.
Responses
Section titled “Responses”A successful response.
object
Examplegenerated
{}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