profile - Control Plane

Manage local profiles For a detailed overview, please visit the manage CLI profiles guide.

cpln profile [SUBCOMMAND]

Commands:
  cpln profile delete <profiles...>   Delete one or more referenced profiles
  cpln profile get [profiles...]      Retrieve one or more profiles
  cpln profile login [ref]            Create a profile named "default" and launch a browser to begin the interactive login process
  cpln profile set-default <profile>  Set the referenced profile as the default
  cpln profile token [profile]        Show the JWT token of the referenced profile
  cpln profile update <profile>       Manage the referenced profile  [aliases: create]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

profile delete

Delete one or more referenced profiles Usage

cpln profile delete <profiles...> [OPTIONS]

Reference

Positionals:
  profile  One or more profile names to delete

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

Common Options Reference

Example

Delete one profile

cpln profile delete default

A table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.

Delete multiple profiles

cpln profile delete demo-profile@example.com default

A table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.

profile get

Retrieve one or more profiles Usage

cpln profile get [profiles...] [OPTIONS]

An empty reference will return all references

Reference

Positionals:
  profiles  One or more profiles to show  [array] [default: []]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

Common Options Reference

Example

cpln profile get default

+--------+---------------------+--------+-------+------------------------+----+----+-------+-----------+
|PROFILE |EMAIL                |DEFAULT |ACTIVE |ENDPOINT                |ORG |GVC |OUTPUT |TIMESTAMPS |
|--------|---------------------|--------|-------|------------------------|----|----|-------|-----------|
|default |test-128@example.com |*       |*      |https:/api.test.cpln.io |    |    |text   |age        |
+--------+---------------------+--------+-------+------------------------+----+----+-------+-----------+

Create a profile named “default” and launch a browser to begin the interactive login process Usage

cpln profile login [ref] [OPTIONS]

Reference

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Positionals:
  ref  The resource reference. Usually it is the name of the resource.

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

Common Options Reference

Example

cpln profile login

A new browser will open displaying the Control Plane login page. 

If the login was successful, the browser will indicate that it can be closed. The CLI will display the login results. Press
Control-C to exit the CLI login.  

If the login failed, the browser and be closed and the CLI will return to the command prompt. Run \`cpln profile login\` again to 
restart the login.

profile set-default

Set the referenced profile as the default Usage

cpln profile set-default <profile> [OPTIONS]

Reference

Positionals:
  profile  Profile name to be set as the default  [required]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

Common Options Reference

Example

cpln profile set-default demo-profile

The referenced profile will be set as the default for all future executions of the CLI commands.  

If the set was successful, the command prompt will return. Otherwise, the error will be shown.

profile token

Show the JWT token of the referenced profile Usage

cpln profile token [profile] [OPTIONS]

An empty reference will return the token for the default profile

Reference

Positionals:
  profile  Profile to retrieve the token for

Command options:
  --serve          Serve token on a local server  [boolean]
  --port           Port for the local server  [number] [default: 43200]
  --jwt            View your jwt for the token server  [boolean]
  --generateToken  Generate a new jwt token for the token server  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

Common Options Reference

Example

cpln profile token demo-profile

A valid JWT token for the referenced profile "demo-profile" will be shown.

Token Server Usage

- 'cpln profile token --serve': Create a server (default port of 43200) instead of outputting the token directly. 
                                This command generates a profile specific token to authenticate against this token server.
- 'cpln profile token --serve --port PORT': Sets the port of the token server.
- 'cpln profile token --jwt': Outputs the token server token for the profile.
- 'cpln profile token --generateToken': Regenerates a token for the profile, for the token server.

An example use case is to integrate the server to a Postman collection. The collection can then make requests to the Control Plane API 
without needing to manually copy the token. After the server is running, by executing the 'cpln profile token --serve' command , the user 
can utilize the Pre-request script below in Postman:

------------------------

const postRequest = {
  url: "http://localhost:" + pm.environment.get("cplnTokenServerPort") + "/" + pm.environment.get("profile") + "/token",
  method: 'GET',
  header: {
    'authorization': "Bearer " + pm.environment.get("cplnTokenServerToken")
  },
};

pm.sendRequest(postRequest, (err, response) => {
    pm.environment.set("token", response.text());
})

------------------------

profile update

Manage the referenced profile Usage

cpln profile update <profile> COMMAND_OPTIONS [OPTIONS]

Reference

Positionals:
  profile  Name of the profile to update. If it does not exist, a new profile with that name will be created  [required]

Command options:
  --login    Launch a browser to begin the interactive login process using the referenced profile
  --default  Set the given profile as the default
  --org      Set the given organization as the default organization of the referenced profile
  --gvc      Set the given GVC as the default GVC of the referenced profile

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

Common Options Reference

Example

Create a new profile

cpln profile update new-profile

If the referenced profile name doesn't exist, a new one will be created.

Perform an interactive login using a custom profile

cpln profile update new-profile --login

A browser will open displaying the Control Plane login page.

If the login was successful, a new profile with the given name will be created
(if it doesn't already exist) and the browser will indicate that it can be closed.

This profile will be marked as the default and used by any future CLI command.

The CLI will display the login results. Press Control-C to exit the CLI login.

If the login failed, the CLI will return to the command prompt.

Run the command again to restart the login flow.

Set the referenced profile as the default profile

cpln profile update new-profile --default

If the update was successful, the referenced profile will be set as the default for all future cpln commands.

Set a default organization and GVC on the referenced profile

cpln profile update new-profile --org demo-cpln-organization --gvc demo-gvc

The referenced organization and GVC will be set as the default on the referenced profile.

Any future execution of a cpln command will use those values.

Remove default organization and GVC on the referenced profile

cpln profile update new-profile --org "" --gvc ""

The specified default organization and GVC will be removed from the referenced profile.

Future executions of any CPLN command will require the --org and the --gvc options.

​profile delete

​profile get

​profile login

​profile set-default

​profile token

​profile update

profile delete

profile get

profile login

profile set-default

profile token

profile update