Vcenter NamespaceManagement Supervisors Certificates SigningRequests CreateSpec
The Vcenter NamespaceManagement Supervisors Certificates SigningRequests CreateSpec schema contains the specification required to create new Certificate Signing Request for the Supervisor.
This schema was added in vSphere API 9.1.0.0.
{
"csr_type": "string",
"key_size": 0,
"common_name": "string",
"country": "string",
"state_or_province": "string",
"locality": "string",
"organization_name": "string",
"organization_unit_name": "string",
"email_address": "string",
"subject_alternative_names": {
"dns_names": [
"string"
],
"ip_addresses": [
"string"
]
}
}Certificate Signing Request kind.
For more information see: Vcenter NamespaceManagement Supervisors Certificates SigningRequests CSRType.
This property was added in vSphere API 9.1.0.0.
Size of key associated with the new Certificate Signing Request.
This property was added in vSphere API 9.1.0.0.
If missing or null, the generated key will be 3072 bits long.
Name identifying the machine. Its value will be set in Certificate Signing Request Subject's CN field.
This property was added in vSphere API 9.1.0.0.
Two-letter country code (as defined in ISO-3166) to be set in Certificate Signing Request Subject's C field.
This property was added in vSphere API 9.1.0.0.
State or province to be set in Certificate Signing Request Subject's ST field.
This property was added in vSphere API 9.1.0.0.
Locality (city) to be set in Certificate Signing Request Subject's L field.
This property was added in vSphere API 9.1.0.0.
Organization to be set in Certificate Signing Request Subject's O field.
This property was added in vSphere API 9.1.0.0.
Organizational Unit to be set in Certificate Signing Request Subject's OU field.
This property was added in vSphere API 9.1.0.0.
Email to be set in Certificate Signing Request Subject Alternative Names.
This property was added in vSphere API 9.1.0.0.
If missing or null, no email address will be set in the Certificate Signing Request.
Subject Alternative Names (SAN) to be set in the Certificate Signing Request.
This property was added in vSphere API 9.1.1.0.
If missing or null, the behavior depends on the Vcenter NamespaceManagement Supervisors Certificates SigningRequests CreateSpec.csr_type:
- For Vcenter NamespaceManagement Supervisors Certificates SigningRequests CSRType.KUBERNETES_API_SERVER: Both the IP address and the DNS names will be automatically populated using active Supervisor configurations. The DNS names are retrieved from Vcenter NamespaceManagement Supervisors Workloads KubeApiServerSettings Info.certificate_dns_names, and the IP addresses are retrieved from the Virtual IP (VIP) addresses configured under Vcenter NamespaceManagement Networks Edges Edge.load_balancer_address_ranges.
- For Vcenter NamespaceManagement Supervisors Certificates SigningRequests CSRType.DEFAULT_NSX_INGRESS: No default Subject Alternative Names will be set.
If this structure is provided, the behavior is governed by the following rules:
For Vcenter NamespaceManagement Supervisors Certificates SigningRequests CSRType.KUBERNETES_API_SERVER:
- If only Vcenter NamespaceManagement Supervisors Certificates SigningRequests SubjectAlternativeNames.dns_names are provided, the IP address will not be automatically populated.
- If only Vcenter NamespaceManagement Supervisors Certificates SigningRequests SubjectAlternativeNames.ip_addresses are provided, the configured default DNS names will still be automatically populated.
- If both fields are provided, the provided DNS names will be combined with the default configured DNS names, and only the provided IP addresses will be set.
For Vcenter NamespaceManagement Supervisors Certificates SigningRequests CSRType.DEFAULT_NSX_INGRESS: No automatic population of default values takes place; only the provided DNS names and/or IP addresses will be added to the Certificate Signing Request.