REST API - create

vcenter namespace management supervisor services: create

Create a supervisor service. If version specs are provided in the spec, new supervisor service versions will be created as part of the operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/vcenter/namespace-management/supervisor-services

{
    "vsphere_spec" : {
        "version_spec" : {
            "trusted_provider" : true,
            "content" : "string"
        }
    },
    "custom_spec" : {
        "version_spec" : {
            "trusted_provider" : true,
            "description" : "string",
            "display_name" : "string",
            "version" : "obj-103",
            "content" : "string"
        },
        "description" : "string",
        "display_name" : "string",
        "supervisor_service" : "obj-103"
    }
}

Body Parameters:

Name	Type	Description
bold = required
-	create_spec	Specification for the supervisor service with version definition.
-.custom_spec	custom_create_spec	The specification required to create a supervisor service with a version from inline content that is not based on the vSphere application service format, instead a plain Kubernetes YAML format. Exactly one of `custom_spec` or `vsphere_spec` must be set. . Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the service will be created from a version based on a plain Kubernetes YAML format.
-.custom_spec.supervisor_service	string	The identifier of the supervisor service. This has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the '-' character allowed anywhere except the first or last character. This identifier must be unique across all Namespaces in this vCenter server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vcenter.namespace_management.SupervisorService`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vcenter.namespace_management.SupervisorService`.
-.custom_spec.display_name	string	A human readable name of the supervisor service. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.custom_spec.description	string	A human readable description of the supervisor service. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, the supervisor service description will be empty.
-.custom_spec.version_spec	custom_create_spec	Supervisor service version specification that provides the service definition for one supervisor service version. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.custom_spec.version_spec.version	string	The identifier of the supervisor service version. This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the '-' and '.' characters allowed anywhere except the first or last character. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vcenter.namespace_management.supervisor_services.Version`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vcenter.namespace_management.supervisor_services.Version`.
-.custom_spec.version_spec.display_name	string	A human readable name of the supervisor service version. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.custom_spec.version_spec.description	string	A human readable description of the supervisor service version. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, the description for the service version will be empty.
-.custom_spec.version_spec.content	string	Inline content that contains all service definition of the version, which shall be base64 encoded. The service definition here doesn't follow the vSphere application service format. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.custom_spec.version_spec.trusted_provider	boolean	Whether or not the supervisor service version is from a trusted provider, this field must be set to false if the service version is not from a trusted provider. If it is set to be true, but the `content` is not signed or the signature is invalid, an `InvalidArgument` will be thrown. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, the default value is true. In this case, the `content` must be signed and will be verified.
-.vsphere_spec	vsphere_create_spec	The specification required to create a supervisor service with a version from inline content that is based on the vSphere application service format. Exactly one of `custom_spec` or `vsphere_spec` must be set. . Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the service will be created from a version based on the vSphere application service format.
-.vsphere_spec.version_spec	vsphere_create_spec	Supervisor service version specification that provides the service definitions for one supervisor service version. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vsphere_spec.version_spec.content	string	Inline content that contains all service definition of the version in vSphere application service format, which shall be base64 encoded. The service definition here follows the vSphere application service format. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vsphere_spec.version_spec.trusted_provider	boolean	Whether or not the supervisor service version is from a trusted provider, this field must be set to false if the service version is not from a trusted provider. If it is set to be true, but the `content` is not signed or the signature is invalid, an `InvalidArgument` will be thrown. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, the default value is true. In this case, the `content` must be signed and will be verified.

Response:

HTTP Status Code: 201

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
400	already_exists	if a supervisor service with the same identifier already exists.
500	error	if the system reports an error while responding to the request.
400	invalid_argument	if `spec` contain any errors or if an invalid name is specified. For example, when the service is from a trusted provider, but no signature is provided or it is invalid.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user doesn't have the SupervisorServices.Manage privilege.