tw managed-identities
Manage organization managed identities for HPC clusters
tw managed-identities list
List organization managed identities
tw managed-identities list [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-o, --organization | Organization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'. | Yes |
tw managed-identities add
Add a managed identity for an HPC cluster. Each organization member then adds their own SSH credentials with 'tw managed-identities credentials add'.
tw managed-identities add [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-o, --organization | Organization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'. | Yes | |
-n, --name | Cluster name. Must be unique per organization. Names consist of alphanumeric, hyphen, and underscore characters. | Yes | |
-p, --platform | Cluster workload manager: altair, lsf, moab, slurm, uge. | Yes | |
-H, --host-name | Hostname of the cluster to connect to via SSH, usually the login node. Must be a fully qualified hostname, not a local IP address. | Yes | |
--port | SSH port for the login connection [default: 22]. | No | 22 |
tw managed-identities view
View managed identity details
tw managed-identities view [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-o, --organization | Organization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'. | Yes | |
-i, --id | Managed identity numeric identifier | Yes | |
-n, --name | Managed identity name | Yes |
tw managed-identities update
Update a managed identity. Changing the host of a cluster used by compute environments may break them.
tw managed-identities update [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-o, --organization | Organization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'. | Yes | |
-i, --id | Managed identity numeric identifier | Yes | |
-n, --name | Managed identity name | Yes | |
--new-name | New cluster name. Must be unique per organization. | No | |
-H, --host-name | New hostname of the cluster to connect to via SSH. | No | |
--port | New SSH port for the login connection. | No |
tw managed-identities delete
Delete a managed identity and all its members' credentials. Compute environments that use it become invalid.
tw managed-identities delete [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-o, --organization | Organization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'. | Yes | |
-i, --id | Managed identity numeric identifier | Yes | |
-n, --name | Managed identity name | Yes | |
--force | Delete the managed identity even if running jobs use its credentials. Those jobs are stopped. By default, a managed identity in use is not deleted. | No |
tw managed-identities credentials
List the organization members' SSH credentials for a managed identity
tw managed-identities credentials [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-o, --organization | Organization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'. | Yes | |
-i, --id | Managed identity numeric identifier | Yes | |
-n, --name | Managed identity name | Yes |
tw managed-identities credentials add
Add SSH credentials to a managed identity
tw managed-identities credentials add [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-m, --member | Platform username of the organization member the credentials belong to. Only organization owners can add credentials for other members [default: you]. | No | |
-l, --linux-username | Linux username of the organization member on the cluster. | Yes | |
-k, --key | Path to the SSH private key file used to connect to the cluster. | Yes | |
-p, --passphrase | Passphrase for an encrypted SSH private key. | No |
tw managed-identities credentials update
Replace the SSH credentials of an organization member in a managed identity
tw managed-identities credentials update [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-m, --member | Platform username of the organization member the credentials belong to. Only organization owners can update credentials of other members [default: you]. | No | |
-l, --linux-username | Linux username of the organization member on the cluster. | Yes | |
-k, --key | Path to the SSH private key file used to connect to the cluster. | Yes | |
-p, --passphrase | Passphrase for an encrypted SSH private key. | No |
tw managed-identities credentials delete
Delete the SSH credentials of an organization member from a managed identity
tw managed-identities credentials delete [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-m, --member | Platform username of the organization member the credentials belong to. Only organization owners can delete credentials of other members [default: you]. | No | |
--force | Delete the credentials even if running jobs use them. Those jobs are stopped. By default, credentials in use are not deleted. | No |