Skip to main content

lease

Usage: pmc lease [OPTIONS] COMMAND [ARGS]...

Lease commands

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│ list List leases │
│ info Get lease info │
│ upgrade-container Upgrade a container │
│ assign-subnode-image Assign a custom subnode image to an existing │
│ container │
│ create-container Create a container │
│ remove-container Remove a container and its associated lease without │
│ refund │
╰─────────────────────────────────────────────────────────────────────────────╯

The lease command (pmc lease) has sub-commands for container lease.

lease list

Usage: pmc lease list [OPTIONS]

List leases

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --account-id=ID Account id │
│ --evm-address=ADDRESS EVM address │
│ -i, --interactive Prompt for item to show details for │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯

The list command (pmc lease list) lists all the active leases.

lease info

Usage: pmc lease info [OPTIONS]

Get lease info

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=NAME Container name │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯

The info command (pmc lease info) shows information about a given lease.

lease upgrade-container

Usage: pmc lease upgrade-container [OPTIONS]

Upgrade a container

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --account-id=ID Account id │
│* --evm-address=ADDRESS EVM address │
│* -n, --name=NAME Container name │
│* --scus=SCUS Number of SCUs │
│* --duration=WEEKS │
│ --extraStorage=GIB (default: 0) │
│* -cn, --cluster-name=TEXT Name of the cluster │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯

The upgrade-container command (pmc lease upgrade-container) upgrades a container.

lease assign-subnode-image

Usage: pmc lease assign-subnode-image [OPTIONS]

Assign a custom subnode image to an existing container

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --account-id=ID Account id │
│* --evm-address=ADDRESS EVM address │
│* -n, --name=NAME Container name │
│ -sin, --subnode-image-name=TEXT Subnode image name │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯

The assign-subnode-image command (pmc lease assign-subnode-image) assigns a custom subnode image to an existing container.

lease create-container

Usage: pmc lease create-container [OPTIONS]

Create a container

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --account-id=ID Account id │
│* --evm-address=ADDRESS EVM address │
│* -cn, --cluster-name=TEXT Name of the cluster │
│* --scus=SCUS Number of SCUs │
│* --duration=WEEKS │
│ --extraStorage=GIB (default: 0) │
│ -sin, --subnode-image-name=TEXT Subnode image name │
│ --auto-renew Auto renew │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯

The create-container command (pmc lease create-container) creates a container.

lease remove-container

Usage: pmc lease remove-container [OPTIONS]

Remove a container and its associated lease without refund

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --account-id=ID Account id │
│* --evm-address=ADDRESS EVM address │
│* -n, --name=NAME Container name │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯

The remove-container command (pmc lease remove-container) removes a container and its associated lease without a refund.