Skip to main content

subnode-image

Usage: pmc subnode-image [OPTIONS] COMMAND [ARGS]...

Interacting with subnode images

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
add Register new subnode image │
│ update Update subnode image │
│ disable Disable subnode image │
enable Enable subnode image │
│ add-to-cluster Add subnode image to cluster │
│ remove-from-cluster Remove subnode image from cluster │
│ info Get information about a subnode image │
│ list List all subnode images │
╰─────────────────────────────────────────────────────────────────────────────╯

The subnode-image command (pmc subnode-image) consists of sub-commands used to manage subnode image.

subnode-image add

Usage: pmc subnode-image add [OPTIONS]

Register new subnode image

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT Image name │
│* --url=TEXT Image URL │
│* --digest=TEXT Image digest │
--type=(COMMON|SPECIAL) Image type (default: COMMON)
│* -desc, --image-description=TEXT │
│ Subnode image description │
│ -gtx, --gtx-modules=TEXT GTX modules exposed by this subnode image (comma │
│ separated list of FQCNs)
│ -sync, --sync-exts=TEXT Synchronization infrastructure extensions exposed│
│ by this subnode image (comma separated list of │
│ FQCNs)
--description=TEXT Proposal description │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

To register a subnode image, use the (pmc subnode-image add) command.

subnode-image update

Usage: pmc subnode-image update [OPTIONS]

Update subnode image

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT Image name │
│* --url=TEXT Image URL │
│* --digest=TEXT Image digest │
--description=TEXT Proposal description │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The update command (pmc subnode-image update) updates information regarding the subnode image.

subnode-image disable

Usage: pmc subnode-image disable [OPTIONS]

Disable subnode image

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT Image name │
--description=TEXT Proposal description │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The disable command (pmc subnode-image disable) disables a subnode image.

subnode-image enable

Usage: pmc subnode-image enable [OPTIONS]

Enable subnode image

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT Image name │
--description=TEXT Proposal description │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The enable command (pmc subnode-image enable) enables a subnode image.

subnode-image add-to-cluster

Usage: pmc subnode-image add-to-cluster [OPTIONS]

Add subnode image to cluster

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -cn, --cluster-name=TEXT Cluster name │
│* -sin, --subnode-image-name=TEXT Subnode image name │
--description=TEXT Proposal description │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The add-to-cluster command (pmc subnode-image add-to-cluster) adds a subnode image to a cluster.

subnode-image remove-from-cluster

Usage: pmc subnode-image remove-from-cluster [OPTIONS]

Remove subnode image from cluster

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -cn, --cluster-name=TEXT Cluster name │
│* -sin, --subnode-image-name=TEXT Subnode image name │
--description=TEXT Proposal description │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The remove-from-cluster command (pmc subnode-image remove-from-cluster) removes a subnode image from cluster.

subnode-image info

Usage: pmc subnode-image info [OPTIONS]

Get information about a subnode image

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT Subnode image name │
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The info command (pmc subnode-image info) shows information about a given subnode image.

subnode-image list

Usage: pmc subnode-image list [OPTIONS]

List all subnode images

╭─ 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 │
--network=TEXT Target network to make requests to (if chromia.yml│
│ is configured)
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ -i, --interactive Prompt for item to show details for
│ -h, --help Show this message and exit
╰─────────────────────────────────────────────────────────────────────────────╯

The list command (pmc subnode-image list) lists all subnode images.