register-on-prem-control-plane¶

Description¶

Register a Private Cloud control plane in Public Cloud.

Synopsis¶

  register-on-prem-control-plane
--pvc-id <value>
--name <value>
--base-url <value>
--saml-identity-provider <value>
[--description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--pvc-id (string)

The account ID of the Private Cloud control plane.

--name (string)

The name of the Private Cloud control plane.

--base-url (string)

The base URL of the Private Cloud control plane.

--saml-identity-provider (string)

The name or ID or CRN of the SAML identity provider from Public Cloud control plane in which users are allowed to operate on the Private Cloud control plane. The same or equivalent SAML IDP should be used by the Public Cloud control plane and the Private Cloud control plane, in order for the user to be mapped by SAML user ID.

--description (string)

The description of the Private Cloud control plane.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

controlPlaneConfiguration -> (object)

Private Cloud control plane configuration.

Form Factors: public, private

pvcId -> (string)

The account ID of the Private Cloud control plane.

pvcCrn -> (string)

The CRN of the Private Cloud control plane.

type -> (string)

The type of a remote cluster. CDP_PVC - CDP Private Cloud control plane.

Form Factors: public, private

name -> (string)

The name of the Private Cloud control plane.

description -> (string)

The description of the Private Cloud control plane.

baseUrl -> (string)

The base URL of the Private Cloud control plane.

idpCrn -> (string)

The IDP CRN of the user.

pvcStatus -> (string)

The status of the Private Cloud control plane.

pvcEnvironmentCount -> (integer)

The total number of environments in the Private Cloud control plane.

lastUpdatedTime -> (datetime)

The date/time for the last updated time.

agentSecretRotationStatus -> (string)

The status of the Jumpgate Agent Secret Rotation in the Private Cloud control plane.

connectivityConfiguration -> (string)

The connectivity configuration to be used by the Private Cloud control plane.

Form Factors¶

public