Skip to content

Network Interface

Network interface represents configuration of a network device. Replace network interface will replace the contents of given network interface object.

ToolDescription
f5xc-api-cemanagement-network-interface-createCreate Network Interface.
f5xc-api-cemanagement-network-interface-getGET Network Interface.
f5xc-api-cemanagement-network-interface-listList Network Interface.
f5xc-api-cemanagement-network-interface-updateReplace Network Interface.
f5xc-api-cemanagement-network-interface-deleteDELETE Network Interface.
ParameterDescriptionExample
metadata.namespaceNamespace-
nameName-
namespaceNamespace-
metadata.nameName-
ParameterDescriptionExample
response_formatThe format in which the configuration object is to be fetched. This could be for example-
label_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter-
report_status_fieldsThe report_status_fields parameter-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.dedicated_interface-
spec.dedicated_management_interface-
spec.ethernet_interface-
spec.layer2_interface-
spec.tunnel_interface-
OptionDescriptionRecommended
spec.dedicated_interface.monitor-
spec.dedicated_interface.monitor_disabled-
OptionDescriptionRecommended
spec.dedicated_interface.cluster-
spec.dedicated_interface.node-
OptionDescriptionRecommended
spec.dedicated_interface.is_primary-
spec.dedicated_interface.not_primary-
OptionDescriptionRecommended
spec.ethernet_interface.dhcp_client-
spec.ethernet_interface.dhcp_server-
spec.ethernet_interface.static_ip-
OptionDescriptionRecommended
spec.ethernet_interface.ipv6_auto_config-
spec.ethernet_interface.no_ipv6_address-
spec.ethernet_interface.static_ipv6_address-
OptionDescriptionRecommended
spec.ethernet_interface.segment_network-
spec.ethernet_interface.site_local_inside_network-
spec.ethernet_interface.site_local_network-
spec.ethernet_interface.storage_network-
OptionDescriptionRecommended
spec.ethernet_interface.untagged-
spec.ethernet_interface.vlan_id-
OptionDescriptionRecommended
spec.ethernet_interface.dhcp_server.automatic_from_end-
spec.ethernet_interface.dhcp_server.automatic_from_start-
spec.ethernet_interface.dhcp_server.interface_ip_map-
OptionDescriptionRecommended
spec.ethernet_interface.dhcp_server.dhcp_networks[].dns_address-
spec.ethernet_interface.dhcp_server.dhcp_networks[].same_as_dgw-
OptionDescriptionRecommended
spec.ethernet_interface.dhcp_server.dhcp_networks[].dgw_address-
spec.ethernet_interface.dhcp_server.dhcp_networks[].first_address-
spec.ethernet_interface.dhcp_server.dhcp_networks[].last_address-
OptionDescriptionRecommended
spec.ethernet_interface.dhcp_server.dhcp_networks[].network_prefix-
OptionDescriptionRecommended
spec.ethernet_interface.ipv6_auto_config.host-
spec.ethernet_interface.ipv6_auto_config.router-
OptionDescriptionRecommended
spec.ethernet_interface.ipv6_auto_config.router.dns_config.local_dns.configured_address-
spec.ethernet_interface.ipv6_auto_config.router.dns_config.local_dns.first_address-
spec.ethernet_interface.ipv6_auto_config.router.dns_config.local_dns.last_address-
OptionDescriptionRecommended
spec.layer2_interface.l2sriov_interface-
spec.layer2_interface.l2vlan_interface-
spec.layer2_interface.l2vlan_slo_interface-

Ask Claude to help you work with Network Interface resources:

“Create a network-interface named ‘example’ in the ‘production’ namespace”

“List all network-interfaces in the ‘production’ namespace”

“Get details of the network-interface named ‘example’ in namespace ‘production‘“

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/network_interfaces" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/network_interfaces/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/network_interfaces" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @network_interface.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/network_interfaces/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"