Immutable Infrastructure

DCSIpHostnamePool [infrastructure.cluster.x-k8s.io/v1beta1]

Description
DCSIpHostnamePool is the Schema for the dcsiphostnamepools API.
Type
object

Specification

PropertyTypeDescription
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

DCSIpHostnamePoolSpec defines the desired state of DCSIpHostnamePool.

statusobject

DCSIpHostnamePoolStatus defines the observed state of DCSIpHostnamePool.

.spec

Description
DCSIpHostnamePoolSpec defines the desired state of DCSIpHostnamePool.
Type
object
Required
pool
PropertyTypeDescription
poolarray

.spec.pool

Type
array

.spec.pool[]

Type
object
PropertyTypeDescription
additionNicarray
dnsstring
dvSwitchNamestring

DVSwitch name for multi-NIC support. If NIC's DVSwitchName or PortGroupName is nil, the VM template's DVSwitchName and PortGroupName will be used as fallback.

gatewaystring
hostnamestring
ipstring
ipv6string
machineNamestring
maskstring
portGroupNamestring
portGroupUrnstring

.spec.pool[].additionNic

Type
array

.spec.pool[].additionNic[]

Type
object
PropertyTypeDescription
dnsstring
dvSwitchNamestring
gatewaystring
ipstring
ipv6string
maskstring
portGroupNamestring
portGroupUrnstring

.status

Description
DCSIpHostnamePoolStatus defines the observed state of DCSIpHostnamePool.
Type
object

API Endpoints

The following API endpoints are available:

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsiphostnamepools
    • DELETE: delete collection of DCSIpHostnamePool
    • GET: list objects of kind DCSIpHostnamePool
    • POST: create a new DCSIpHostnamePool
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsiphostnamepools/{name}
    • DELETE: delete the specified DCSIpHostnamePool
    • GET: read the specified DCSIpHostnamePool
    • PATCH: partially update the specified DCSIpHostnamePool
    • PUT: replace the specified DCSIpHostnamePool
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsiphostnamepools/{name}/status
    • GET: read status of the specified DCSIpHostnamePool
    • PATCH: partially update status of the specified DCSIpHostnamePool
    • PUT: replace status of the specified DCSIpHostnamePool

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsiphostnamepools

HTTP method
DELETE
Description
delete collection of DCSIpHostnamePool
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind DCSIpHostnamePool
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePoolList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new DCSIpHostnamePool
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyDCSIpHostnamePool schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
201 - CreatedDCSIpHostnamePool schema
202 - AcceptedDCSIpHostnamePool schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsiphostnamepools/{name}

HTTP method
DELETE
Description
delete the specified DCSIpHostnamePool
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified DCSIpHostnamePool
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified DCSIpHostnamePool
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified DCSIpHostnamePool
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyDCSIpHostnamePool schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
201 - CreatedDCSIpHostnamePool schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsiphostnamepools/{name}/status

HTTP method
GET
Description
read status of the specified DCSIpHostnamePool
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified DCSIpHostnamePool
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified DCSIpHostnamePool
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyDCSIpHostnamePool schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDCSIpHostnamePool schema
201 - CreatedDCSIpHostnamePool schema
401 - UnauthorizedEmpty