Vcenter Namespaces Instances VsphereNetworkConfigUpdateSpec

The Vcenter Namespaces Instances VsphereNetworkConfigUpdateSpec schema contains Vcenter Namespaces Instances NetworkProvider.VSPHERE_NETWORK network configurations that can be applied to an existing vSphere Namespace.

This schema was added in vSphere API 9.1.0.0.

JSON Example

{
    "networks_to_add": [
        "string"
    ],
    "networks_to_remove": [
        "string"
    ]
}

array of string

networks_to_add

Optional

The vSphere Namespace's network objects to be added to this namespace. The values of this list must reference names of pre-existing Vcenter NamespaceManagement Networks Info schemas.

The networks must be configured with Vcenter Namespaces Instances NetworkProvider.VSPHERE_NETWORK as their network provider type. Networks with other provider types will result in an Vapi Std Errors InvalidArgument error.

Networks that are already associated with this namespace will be silently ignored during the update operation.

This property was added in vSphere API 9.1.0.0.

If missing or null, existing networks in this vSphere Namespace will not be modified.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network.

array of string

networks_to_remove

Optional

The vSphere Namespace's network objects to be removed from this namespace.

Each network in this list must be present in Vcenter Namespaces Instances VsphereNetworkConfigInfo.networks. Networks that are not currently associated with the namespace will result in an Vapi Std Errors InvalidArgument error.

The network specified in Vcenter Namespaces Instances VsphereNetworkConfigInfo.default_workload_network may not be removed from the namespace. Attempting to remove the default network will result in an Vapi Std Errors InvalidArgument error.

The actual removal of a network will be deferred until all workloads in the namespace have stopped using that network. The network will remain accessible to existing workloads until they are migrated or terminated. Networks will be marked with Vcenter Namespaces Instances NetworkInfo.config_status status Vcenter Namespaces Instances NetworkConfigStatus.REMOVING and may be found via Vcenter Namespaces Instances VsphereNetworkConfigInfo.networks until they are fully removed.

This property was added in vSphere API 9.1.0.0.

If missing or null, no networks will be removed from this vSphere Namespace.