Network [operator.openshift.io/v1] - Operator APIs | API reference

Specification
API endpoints
- /apis/operator.openshift.io/v1/networks
- /apis/operator.openshift.io/v1/networks/{name}

Description: Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator.
Type: object

Specification

Property Type Description

Property	Type	Description
`.apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`.kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`.spec`	`object`	NetworkSpec is the top-level network configuration object.
`.status`	`object`	NetworkStatus is currently unused. Instead, status is reported in the Network.config.openshift.io object.

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.spec

object

NetworkSpec is the top-level network configuration object.

.status

object

NetworkStatus is currently unused. Instead, status is reported in the Network.config.openshift.io object.

.spec

Description

NetworkSpec is the top-level network configuration object.

Type

object

Required

defaultNetwork

Property Type Description

Property	Type	Description
`additionalNetworks`	`array`	additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.
`additionalNetworks[]`	`object`	AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one "Config" that matches the type.
`clusterNetwork`	`array`	clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.
`clusterNetwork[]`	`object`	ClusterNetworkEntry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. Not all network providers support multiple ClusterNetworks
`defaultNetwork`	`object`	defaultNetwork is the "default" network that all pods will receive
`deployKubeProxy`	`boolean`	deployKubeProxy specifies whether or not a standalone kube-proxy should be deployed by the operator. Some network providers include kube-proxy or similar functionality. If unset, the plugin will attempt to select the correct value, which is false when OpenShift SDN and ovn-kubernetes are used and true otherwise.
`disableMultiNetwork`	`boolean`	disableMultiNetwork specifies whether or not multiple pod network support should be disabled. If unset, this property defaults to 'false' and multiple network support is enabled.
`kubeProxyConfig`	`object`	kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.
`logLevel`	`string`	logLevel allows configuring the logging level of the components deployed by the operator. Currently only Kuryr SDN is affected by this setting. Please note that turning on extensive logging may affect performance. The default value is "Normal".
`serviceNetwork`	`array (string)`	serviceNetwork is the ip address pool to use for Service IPs Currently, all existing network providers only support a single value here, but this is an array to allow for growth.

additionalNetworks

array

additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.

additionalNetworks[]

object

AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one "Config" that matches the type.

clusterNetwork

array

clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.

clusterNetwork[]

object

ClusterNetworkEntry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. Not all network providers support multiple ClusterNetworks

defaultNetwork

object

defaultNetwork is the "default" network that all pods will receive

deployKubeProxy

boolean

deployKubeProxy specifies whether or not a standalone kube-proxy should be deployed by the operator. Some network providers include kube-proxy or similar functionality. If unset, the plugin will attempt to select the correct value, which is false when OpenShift SDN and ovn-kubernetes are used and true otherwise.

disableMultiNetwork

boolean

disableMultiNetwork specifies whether or not multiple pod network support should be disabled. If unset, this property defaults to 'false' and multiple network support is enabled.

kubeProxyConfig

object

kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.

logLevel

string

logLevel allows configuring the logging level of the components deployed by the operator. Currently only Kuryr SDN is affected by this setting. Please note that turning on extensive logging may affect performance. The default value is "Normal".

serviceNetwork

array (string)

serviceNetwork is the ip address pool to use for Service IPs Currently, all existing network providers only support a single value here, but this is an array to allow for growth.

.spec.additionalNetworks

Description: additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.
Type: array

.spec.additionalNetworks[]

Description

Type

object

Required

type
name

Property Type Description

Property	Type	Description
`name`	`string`	name is the name of the network. This will be populated in the resulting CRD This must be unique.
`namespace`	`string`	namespace is the namespace of the network. This will be populated in the resulting CRD If not given the network will be created in the default namespace.
`rawCNIConfig`	`string`	rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD
`simpleMacvlanConfig`	`object`	SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
`type`	`string`	type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan

name

string

name is the name of the network. This will be populated in the resulting CRD This must be unique.

namespace

string

namespace is the namespace of the network. This will be populated in the resulting CRD If not given the network will be created in the default namespace.

rawCNIConfig

string

rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD

simpleMacvlanConfig

object

SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan

type

string

type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan

.spec.additionalNetworks[].simpleMacvlanConfig

Description: SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
Type: object

Property Type Description

Property	Type	Description
`ipamConfig`	`object`	IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
`master`	`string`	master is the host interface to create the macvlan interface from. If not specified, it will be default route interface
`mode`	`string`	mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge
`mtu`	`integer`	mtu is the mtu to use for the macvlan interface. if unset, host’s kernel will select the value.

ipamConfig

object

IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).

master

string

master is the host interface to create the macvlan interface from. If not specified, it will be default route interface

mode

string

mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge

mtu

integer

mtu is the mtu to use for the macvlan interface. if unset, host’s kernel will select the value.

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig

Description: IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
Type: object

Property Type Description

Property	Type	Description
`staticIPAMConfig`	`object`	StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
`type`	`string`	Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic

staticIPAMConfig

object

StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic

type

string

Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig

Description: StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
Type: object

Property Type Description

Property	Type	Description
`addresses`	`array`	Addresses configures IP address for the interface
`addresses[]`	`object`	StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses
`dns`	`object`	DNS configures DNS for the interface
`routes`	`array`	Routes configures IP routes for the interface
`routes[]`	`object`	StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes

addresses

array

Addresses configures IP address for the interface

addresses[]

object

StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses

dns

object

DNS configures DNS for the interface

routes

array

Routes configures IP routes for the interface

routes[]

object

StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses

Description: Addresses configures IP address for the interface
Type: array

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses[]

Description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses
Type: object

Property Type Description

Property	Type	Description
`address`	`string`	Address is the IP address in CIDR format
`gateway`	`string`	Gateway is IP inside of subnet to designate as the gateway

address

string

Address is the IP address in CIDR format

gateway

string

Gateway is IP inside of subnet to designate as the gateway

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns

Description: DNS configures DNS for the interface
Type: object

Property Type Description

Property	Type	Description
`domain`	`string`	Domain configures the domainname the local domain used for short hostname lookups
`nameservers`	`array (string)`	Nameservers points DNS servers for IP lookup
`search`	`array (string)`	Search configures priority ordered search domains for short hostname lookups

domain

string

Domain configures the domainname the local domain used for short hostname lookups

nameservers

array (string)

Nameservers points DNS servers for IP lookup

search

array (string)

Search configures priority ordered search domains for short hostname lookups

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes

Description: Routes configures IP routes for the interface
Type: array

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes[]

Description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes
Type: object

Property Type Description

Property	Type	Description
`destination`	`string`	Destination points the IP route destination
`gateway`	`string`	Gateway is the route’s next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).

destination

string

Destination points the IP route destination

gateway

string

Gateway is the route’s next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).

.spec.clusterNetwork

Description: clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.
Type: array

.spec.clusterNetwork[]

Description

Type

object

Required

cidr
hostPrefix

Property Type Description

Property	Type	Description
`cidr`	`string`
`hostPrefix`	`integer`

cidr

string

hostPrefix

integer

.spec.defaultNetwork

Description

defaultNetwork is the "default" network that all pods will receive

Type

object

Required

type

Property Type Description

Property	Type	Description
`kuryrConfig`	`object`	KuryrConfig configures the kuryr plugin
`openshiftSDNConfig`	`object`	openShiftSDNConfig configures the openshift-sdn plugin
`ovnKubernetesConfig`	`object`	ovnKubernetesConfig configures the ovn-kubernetes plugin.
`type`	`string`	type is the type of network All NetworkTypes are supported except for NetworkTypeRaw

kuryrConfig

object

KuryrConfig configures the kuryr plugin

openshiftSDNConfig

object

openShiftSDNConfig configures the openshift-sdn plugin

ovnKubernetesConfig

object

ovnKubernetesConfig configures the ovn-kubernetes plugin.

type

string

type is the type of network All NetworkTypes are supported except for NetworkTypeRaw

.spec.defaultNetwork.kuryrConfig

Description: KuryrConfig configures the kuryr plugin
Type: object

Property Type Description

Property	Type	Description
`controllerProbesPort`	`integer`	The port kuryr-controller will listen for readiness and liveness requests.
`daemonProbesPort`	`integer`	The port kuryr-daemon will listen for readiness and liveness requests.
`enablePortPoolsPrepopulation`	`boolean`	enablePortPoolsPrepopulation when true will make Kuryr prepopulate each newly created port pool with a minimum number of ports. Kuryr uses Neutron port pooling to fight the fact that it takes a significant amount of time to create one. Instead of creating it when pod is being deployed, Kuryr keeps a number of ports ready to be attached to pods. By default port prepopulation is disabled.
`openStackServiceNetwork`	`string`	openStackServiceNetwork contains the CIDR of network from which to allocate IPs for OpenStack Octavia’s Amphora VMs. Please note that with Amphora driver Octavia uses two IPs from that network for each loadbalancer - one given by OpenShift and second for VRRP connections. As the first one is managed by OpenShift’s and second by Neutron’s IPAMs, those need to come from different pools. Therefore `openStackServiceNetwork` needs to be at least twice the size of `serviceNetwork`, and whole `serviceNetwork` must be overlapping with `openStackServiceNetwork`. cluster-network-operator will then make sure VRRP IPs are taken from the ranges inside `openStackServiceNetwork` that are not overlapping with `serviceNetwork`, effectivly preventing conflicts. If not set cluster-network-operator will use `serviceNetwork` expanded by decrementing the prefix size by 1.
`poolBatchPorts`	`integer`	poolBatchPorts sets a number of ports that should be created in a single batch request to extend the port pool. The default is 3. For more information about port pools see enablePortPoolsPrepopulation setting.
`poolMaxPorts`	`integer`	poolMaxPorts sets a maximum number of free ports that are being kept in a port pool. If the number of ports exceeds this setting, free ports will get deleted. Setting 0 will disable this upper bound, effectively preventing pools from shrinking and this is the default value. For more information about port pools see enablePortPoolsPrepopulation setting.
`poolMinPorts`	`integer`	poolMinPorts sets a minimum number of free ports that should be kept in a port pool. If the number of ports is lower than this setting, new ports will get created and added to pool. The default is 1. For more information about port pools see enablePortPoolsPrepopulation setting.

controllerProbesPort

integer

The port kuryr-controller will listen for readiness and liveness requests.

daemonProbesPort

integer

The port kuryr-daemon will listen for readiness and liveness requests.

enablePortPoolsPrepopulation

boolean

enablePortPoolsPrepopulation when true will make Kuryr prepopulate each newly created port pool with a minimum number of ports. Kuryr uses Neutron port pooling to fight the fact that it takes a significant amount of time to create one. Instead of creating it when pod is being deployed, Kuryr keeps a number of ports ready to be attached to pods. By default port prepopulation is disabled.

openStackServiceNetwork

string

openStackServiceNetwork contains the CIDR of network from which to allocate IPs for OpenStack Octavia’s Amphora VMs. Please note that with Amphora driver Octavia uses two IPs from that network for each loadbalancer - one given by OpenShift and second for VRRP connections. As the first one is managed by OpenShift’s and second by Neutron’s IPAMs, those need to come from different pools. Therefore openStackServiceNetwork needs to be at least twice the size of serviceNetwork, and whole serviceNetwork must be overlapping with openStackServiceNetwork. cluster-network-operator will then make sure VRRP IPs are taken from the ranges inside openStackServiceNetwork that are not overlapping with serviceNetwork, effectivly preventing conflicts. If not set cluster-network-operator will use serviceNetwork expanded by decrementing the prefix size by 1.

poolBatchPorts

integer

poolBatchPorts sets a number of ports that should be created in a single batch request to extend the port pool. The default is 3. For more information about port pools see enablePortPoolsPrepopulation setting.

poolMaxPorts

integer

poolMaxPorts sets a maximum number of free ports that are being kept in a port pool. If the number of ports exceeds this setting, free ports will get deleted. Setting 0 will disable this upper bound, effectively preventing pools from shrinking and this is the default value. For more information about port pools see enablePortPoolsPrepopulation setting.

poolMinPorts

integer

poolMinPorts sets a minimum number of free ports that should be kept in a port pool. If the number of ports is lower than this setting, new ports will get created and added to pool. The default is 1. For more information about port pools see enablePortPoolsPrepopulation setting.

.spec.defaultNetwork.openshiftSDNConfig

Description: openShiftSDNConfig configures the openshift-sdn plugin
Type: object

Property Type Description

Property	Type	Description
`enableUnidling`	`boolean`	enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled.
`mode`	`string`	mode is one of "Multitenant", "Subnet", or "NetworkPolicy"
`mtu`	`integer`	mtu is the mtu to use for the tunnel interface. Defaults to 1450 if unset. This must be 50 bytes smaller than the machine’s uplink.
`useExternalOpenvswitch`	`boolean`	useExternalOpenvswitch tells the operator not to install openvswitch, because it will be provided separately. If set, you must provide it yourself.
`vxlanPort`	`integer`	vxlanPort is the port to use for all vxlan packets. The default is 4789.

enableUnidling

boolean

enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled.

mode

string

mode is one of "Multitenant", "Subnet", or "NetworkPolicy"

mtu

integer

mtu is the mtu to use for the tunnel interface. Defaults to 1450 if unset. This must be 50 bytes smaller than the machine’s uplink.

useExternalOpenvswitch

boolean

useExternalOpenvswitch tells the operator not to install openvswitch, because it will be provided separately. If set, you must provide it yourself.

vxlanPort

integer

vxlanPort is the port to use for all vxlan packets. The default is 4789.

.spec.defaultNetwork.ovnKubernetesConfig

Description: ovnKubernetesConfig configures the ovn-kubernetes plugin.
Type: object

Property Type Description

Property	Type	Description
`genevePort`	`integer`	geneve port is the UDP port to be used by geneve encapulation. Default is 6081
`hybridOverlayConfig`	`object`	HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.
`mtu`	`integer`	mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400

genevePort

integer

geneve port is the UDP port to be used by geneve encapulation. Default is 6081

hybridOverlayConfig

object

HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.

mtu

integer

mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400

.spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig

Description: HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.
Type: object

Property Type Description

Property	Type	Description
`hybridClusterNetwork`	`array`	HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
`hybridClusterNetwork[]`	`object`	ClusterNetworkEntry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. Not all network providers support multiple ClusterNetworks

hybridClusterNetwork

array

HybridClusterNetwork defines a network space given to nodes on an additional overlay network.

hybridClusterNetwork[]

object

.spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork

Description: HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
Type: array

.spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork[]

Description: ClusterNetworkEntry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. Not all network providers support multiple ClusterNetworks
Type: object

Property Type Description

Property	Type	Description
`cidr`	`string`
`hostPrefix`	`integer`

cidr

string

hostPrefix

integer

.spec.kubeProxyConfig

Description: kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.
Type: object

Property Type Description

Property	Type	Description
`bindAddress`	`string`	The address to "bind" on Defaults to 0.0.0.0
`iptablesSyncPeriod`	`string`	The period that iptables rules are refreshed. Default: 30s
`proxyArguments`	`object`	Any additional arguments to pass to the kubeproxy process
`proxyArguments{}`	`array (string)`	ProxyArgumentList is a list of arguments to pass to the kubeproxy process

bindAddress

string

The address to "bind" on Defaults to 0.0.0.0

iptablesSyncPeriod

string

The period that iptables rules are refreshed. Default: 30s

proxyArguments

object

Any additional arguments to pass to the kubeproxy process

proxyArguments{}

array (string)

ProxyArgumentList is a list of arguments to pass to the kubeproxy process

.spec.kubeProxyConfig.proxyArguments

Description: Any additional arguments to pass to the kubeproxy process
Type: object

.status

Description: NetworkStatus is currently unused. Instead, status is reported in the Network.config.openshift.io object.
Type: object

API endpoints

The following API endpoints are available:

/apis/operator.openshift.io/v1/networks
- DELETE: delete collection of Network
- GET: list objects of kind Network
- POST: create a Network
/apis/operator.openshift.io/v1/networks/{name}
- DELETE: delete a Network
- GET: read the specified Network
- PATCH: partially update the specified Network
- PUT: replace the specified Network

/apis/operator.openshift.io/v1/networks

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of Network

Table 2. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind Network

Table 4. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`NetworkList operator.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a Network

Table 6. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 7. Body parameters
Parameter	Type	Description
`body`	`Network operator.openshift.io/v1`

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Network operator.openshift.io/v1`
201 - Created	`Network operator.openshift.io/v1`
202 - Accepted	`Network operator.openshift.io/v1`
401 - Unauthorized	Empty

/apis/operator.openshift.io/v1/networks/{name}

Table 9. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Network

Table 10. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a Network

Table 11. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 12. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
202 - Accepted	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Network

Table 14. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`Network operator.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Network

Table 16. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 17. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`Network operator.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Network

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 20. Body parameters
Parameter	Type	Description
`body`	`Network operator.openshift.io/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`Network operator.openshift.io/v1`
201 - Created	`Network operator.openshift.io/v1`
401 - Unauthorized	Empty