diff --git a/.github/workflows/build-boot-artifacts.yml b/.github/workflows/build-boot-artifacts.yml index 0890194dcc..a730038ab6 100644 --- a/.github/workflows/build-boot-artifacts.yml +++ b/.github/workflows/build-boot-artifacts.yml @@ -395,7 +395,7 @@ jobs: if [[ "${{ inputs.arch }}" == "x86_64" ]]; then EXPECTED_FILES=( "pxe/static/blobs/internal/x86_64/ipxe.efi" - "target/debug/carbide-admin-cli" + "target/debug/nico-admin-cli" # target/debs/* checked separately ) else @@ -494,7 +494,7 @@ jobs: # so missing files (like BFB artifacts when disabled) won't fail the build if [[ "${{ inputs.build_type }}" == "boot" ]]; then if [[ "${{ inputs.arch }}" == "x86_64" ]]; then - ARTIFACTS='["pxe/static/blobs/internal/x86_64/ipxe.efi", "target/debug/carbide-admin-cli", "target/debs/*"]' + ARTIFACTS='["pxe/static/blobs/internal/x86_64/ipxe.efi", "target/debug/nico-admin-cli", "target/debs/*"]' else # Lists all expected BFB artifacts even though some may not be generated (BFB build is disabled) # This matches GitLab CI behavior where artifact paths are listed but upload succeeds if files don't exist @@ -518,7 +518,7 @@ jobs: name: ${{ inputs.build_type }}-artifacts-${{ inputs.arch }}-${{ github.run_id }} path: | pxe/static/blobs/ - target/debug/carbide-admin-cli + target/debug/nico-admin-cli target/debs/ target/aarch64-unknown-linux-gnu/ pxe/mkosi.profiles/ diff --git a/Cargo.lock b/Cargo.lock index 406facc83d..bee303148d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1035,55 +1035,6 @@ version = "1.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33" -[[package]] -name = "carbide-admin-cli" -version = "0.0.1" -dependencies = [ - "bmc-vendor", - "carbide-health-report", - "carbide-libmlx", - "carbide-libmlx-model", - "carbide-macros", - "carbide-measured-boot", - "carbide-network", - "carbide-rpc", - "carbide-rpc-utils", - "carbide-secrets", - "carbide-ssh", - "carbide-tls", - "carbide-utils", - "carbide-uuid", - "carbide-version", - "chrono", - "clap", - "clap_complete", - "clap_mangen", - "color-eyre", - "csv", - "eyre", - "futures", - "ipnet", - "libredfish", - "librms", - "mac_address", - "pandoc", - "prettytable-rs", - "reqwest 0.13.4", - "serde", - "serde_json", - "serde_yaml", - "thiserror 2.0.18", - "tokio", - "toml 1.1.2+spec-1.1.0", - "tonic", - "tracing", - "tracing-subscriber", - "urlencoding", - "uuid", - "x509-parser", - "zip", -] - [[package]] name = "carbide-agent" version = "0.1.0" @@ -7202,6 +7153,55 @@ dependencies = [ "tokio", ] +[[package]] +name = "nico-admin-cli" +version = "0.0.1" +dependencies = [ + "bmc-vendor", + "carbide-health-report", + "carbide-libmlx", + "carbide-libmlx-model", + "carbide-macros", + "carbide-measured-boot", + "carbide-network", + "carbide-rpc", + "carbide-rpc-utils", + "carbide-secrets", + "carbide-ssh", + "carbide-tls", + "carbide-utils", + "carbide-uuid", + "carbide-version", + "chrono", + "clap", + "clap_complete", + "clap_mangen", + "color-eyre", + "csv", + "eyre", + "futures", + "ipnet", + "libredfish", + "librms", + "mac_address", + "pandoc", + "prettytable-rs", + "reqwest 0.13.4", + "serde", + "serde_json", + "serde_yaml", + "thiserror 2.0.18", + "tokio", + "toml 1.1.2+spec-1.1.0", + "tonic", + "tracing", + "tracing-subscriber", + "urlencoding", + "uuid", + "x509-parser", + "zip", +] + [[package]] name = "nico-test-support" version = "0.0.0" diff --git a/Makefile.toml b/Makefile.toml index 78062b16e1..fe5ba2f7d1 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -83,52 +83,53 @@ args = [ [tasks.build-cli-ci] category = "Build" -description = "Build carbide-admin-cli in CI" +description = "Build nico-admin-cli in CI" workspace = false script = ''' -cargo build -p carbide-admin-cli +cargo build -p nico-admin-cli # Emit man pages as a build artifact via the hidden `generate-man` subcommand. -cargo run -p carbide-admin-cli -- generate-man --out-dir target/man +cargo run -p nico-admin-cli -- generate-man --out-dir target/man ''' [tasks.gen-man] category = "Build" -description = "Generate carbide-admin-cli man pages into target/man" +description = "Generate nico-admin-cli man pages into target/man" workspace = false script = ''' -cargo run -p carbide-admin-cli -- generate-man --out-dir target/man +cargo run -p nico-admin-cli -- generate-man --out-dir target/man ''' [tasks.gen-cli-docs] category = "Build" -description = "Generate the carbide-admin-cli markdown reference into docs/cli" +description = "Generate the nico-admin-cli markdown reference into docs/manuals/nico-admin-cli" workspace = false # `generate-cli-docs` renders each command's man page and converts it to # markdown with pandoc, so the `pandoc` binary must be installed. It writes one -# directory per top-level command under docs/cli/commands plus the four domain -# index files (Hardware/Network/Tenant/Admin). The hand-authored pages -# (README.md, setup.md, workflows.md, rest-cli-parity.md) are left alone. +# directory per top-level command under docs/manuals/nico-admin-cli/commands +# plus the four domain index files (Hardware/Network/Tenant/Admin). The +# hand-authored pages (README.md, setup.md, workflows.md, rest-cli-parity.md) +# are left alone. script = ''' -cargo run -p carbide-admin-cli -- generate-cli-docs --out-dir docs/cli +cargo run -p nico-admin-cli -- generate-cli-docs --out-dir docs/manuals/nico-admin-cli ''' [tasks.check-cli-docs] category = "Test" -description = "Fail if docs/cli is stale or a command is missing a domain" +description = "Fail if docs/manuals/nico-admin-cli is stale or a command is missing a domain" workspace = false # Keeps the checked-in CLI reference honest as commands are added. First the # domain-mapping test fails CI if a new command is not categorized in # cli_domains.yaml; then we regenerate and fail if the result differs from # what is committed (regenerate locally with `cargo make gen-cli-docs`). script = ''' -cargo test -p carbide-admin-cli cfg::cli_options::tests -cargo run -p carbide-admin-cli -- generate-cli-docs --out-dir docs/cli -git diff --exit-code -- docs/cli +cargo test -p nico-admin-cli cfg::cli_options::tests +cargo run -p nico-admin-cli -- generate-cli-docs --out-dir docs/manuals/nico-admin-cli +git diff --exit-code -- docs/manuals/nico-admin-cli ''' [tasks.build-cli] category = "Build" -description = "Build carbide-admin-cli locally using debian container. Ensures correct GCC version is used." +description = "Build nico-admin-cli locally using debian container. Ensures correct GCC version is used." workspace = false script = ''' docker run \ @@ -139,7 +140,7 @@ docker run \ --volume $CARGO_HOME:/cargo \ --env CARGO_HOME=/cargo \ "${BUILD_CONTAINER_X86_URL}" \ - cargo build -p carbide-admin-cli --release + cargo build -p nico-admin-cli --release ''' dependencies = ["check-cargo-home-set"] @@ -197,7 +198,7 @@ script = ''' set -e if [ -z "$CARGO_HOME" ]; then CARGO_HOME="$HOME/.cargo"; fi docker build -f ${REPO_ROOT}/dev/docker/Dockerfile.build-container-x86_64 -t carbide-build-x86_64 ${REPO_ROOT}/dev/docker -echo "Image carbide-build-x86_64 built. Run: cargo make cargo-docker -- build -p carbide-admin-cli --release" +echo "Image carbide-build-x86_64 built. Run: cargo make cargo-docker -- build -p nico-admin-cli --release" ''' [tasks.build-cargo-docker-image-minimal] @@ -207,7 +208,7 @@ workspace = false script = ''' set -e docker build -f ${REPO_ROOT}/dev/docker/Dockerfile.cargo-docker-minimal -t carbide-build-minimal ${REPO_ROOT}/dev/docker -echo "Image carbide-build-minimal built. Run: cargo make cargo-docker-minimal -- build -p carbide-admin-cli --release" +echo "Image carbide-build-minimal built. Run: cargo make cargo-docker-minimal -- build -p nico-admin-cli --release" ''' [tasks.build-pxe-build-container] @@ -269,7 +270,7 @@ dependencies = ["check-cargo-home-set"] script = ''' set -e if [ -z "$CARGO_HOME" ]; then CARGO_HOME="$HOME/.cargo"; fi -CARGO_ARGS="${CARGO_MAKE_TASK_ARGS:-build -p carbide-admin-cli --release}" +CARGO_ARGS="${CARGO_MAKE_TASK_ARGS:-build -p nico-admin-cli --release}" CARGO_ARGS="${CARGO_ARGS//;/ }" CARGO_ARGS="${CARGO_ARGS#-- }" docker run --rm \ @@ -307,7 +308,7 @@ script = ''' set -e if [ -z "$CARGO_HOME" ]; then CARGO_HOME="$HOME/.cargo"; fi # cargo-make may join task args with semicolons; normalize to spaces and strip leading -- -CARGO_ARGS="${CARGO_MAKE_TASK_ARGS:-build -p carbide-admin-cli --release}" +CARGO_ARGS="${CARGO_MAKE_TASK_ARGS:-build -p nico-admin-cli --release}" CARGO_ARGS="${CARGO_ARGS//;/ }" CARGO_ARGS="${CARGO_ARGS#-- }" # Pass DATABASE_URL into container so DB tests can connect (use host.docker.internal from Mac) @@ -364,7 +365,7 @@ docker run --rm \ [tasks.build-cli-cross-aarch64] category = "Build" -description = "Cross compile forge-scout and carbide-admin-cli for aarch64, intended only for local artifact builds." +description = "Cross compile forge-scout and nico-admin-cli for aarch64, intended only for local artifact builds." workspace = false script = ''' docker run --rm -v $REPO_ROOT:/carbide --user $(id -u):$(id -g) \ @@ -376,11 +377,11 @@ docker run --rm -v $REPO_ROOT:/carbide --user $(id -u):$(id -g) \ "--release" \ "--target=aarch64-unknown-linux-gnu" \ "-p" \ - "carbide-admin-cli" \ + "nico-admin-cli" \ "-p" \ "carbide-scout" docker run --rm -v $REPO_ROOT:/carbide --user $(id -u):$(id -g) build-artifacts-container-cross-aarch64:latest "aarch64-linux-gnu-strip" \ - "/carbide/target/aarch64-unknown-linux-gnu/release/carbide-admin-cli" \ + "/carbide/target/aarch64-unknown-linux-gnu/release/nico-admin-cli" \ "/carbide/target/aarch64-unknown-linux-gnu/release/forge-scout" ''' dependencies = ["check-cargo-home-set", "build-cross-docker-image"] @@ -613,7 +614,7 @@ args = ["clippy", "--locked", "--all-targets", "--all-features", "--release"] [tasks.build-debug-test-prerequisites] script = ''' -cargo build -p carbide-agent -p carbide-admin-cli -p carbide-api +cargo build -p carbide-agent -p nico-admin-cli -p carbide-api ''' workspace = false @@ -651,7 +652,7 @@ for artifact in \ carbide-api \ carbide \ carbide-dns \ - carbide-admin-cli \ + nico-admin-cli \ carbide-dsx-exchange-consumer \ forge-dpu-agent \ forge-dhcp-server \ diff --git a/crates/admin-cli/AGENTS.md b/crates/admin-cli/AGENTS.md index 97c9e3b914..b1bcf34499 100644 --- a/crates/admin-cli/AGENTS.md +++ b/crates/admin-cli/AGENTS.md @@ -1,7 +1,7 @@ # AGENTS.md — admin-cli Guidance for AI coding agents (and humans) working on the admin CLI -(`carbide-admin-cli`). This file is symlinked to `CLAUDE.md`; edit +(`nico-admin-cli`). This file is symlinked to `CLAUDE.md`; edit `AGENTS.md` and the other name follows. See the repo-root [`AGENTS.md`](../../AGENTS.md) for build/test/lint @@ -14,7 +14,7 @@ and how we surface **errors** to the user ("Error messages" at the end). Every leaf subcommand carries a worked `EXAMPLES:` section, rendered by clap's `after_long_help`. It appears at the bottom of `--help` (the long help; `-h` shows only the summary). The goal is that a reader who runs -`carbide-admin-cli --help` sees concrete, copy-pasteable +`nico-admin-cli --help` sees concrete, copy-pasteable invocations covering the realistic ways to use that command — not just a list of flags. @@ -29,10 +29,10 @@ struct (or enum) that backs the subcommand: EXAMPLES: List all VPCs: - $ carbide-admin-cli vpc show + $ nico-admin-cli vpc show Show details for one VPC: - $ carbide-admin-cli vpc show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { @@ -49,7 +49,7 @@ Formatting rules, all load-bearing: closing `"`. - The leading `\` after the opening quote swallows the first newline so the block starts cleanly at `EXAMPLES:`. -- Always use the real binary name `carbide-admin-cli` and the **kebab-case +- Always use the real binary name `nico-admin-cli` and the **kebab-case command path** as clap renders it (see "Getting the command path" below). - For commands too long for one source line, break with a trailing `\` @@ -65,7 +65,7 @@ Formatting rules, all load-bearing: EXAMPLES: Peer two VPCs: - $ carbide-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 ")] @@ -180,7 +180,7 @@ variant itself: EXAMPLES: Change the UEFI password: - $ carbide-admin-cli redfish ... change-uefi-password --current-password X --new-password Y + $ nico-admin-cli redfish ... change-uefi-password --current-password X --new-password Y \")] ChangeUefiPassword(UefiPassword), @@ -216,17 +216,17 @@ the common trivial case. Build, then render the long help and read the bottom: ```bash -cargo build -p carbide-admin-cli +cargo build -p nico-admin-cli # Capture to a file — the sandbox has a pipe-drop bug, so `... | grep` # may silently show nothing even when the block is present. -cargo run -q -p carbide-admin-cli -- --help > tmp/help.txt 2>&1 +cargo run -q -p nico-admin-cli -- --help > tmp/help.txt 2>&1 sed -n '/EXAMPLES/,$p' tmp/help.txt ``` Confirm the wrapped (`\`-continued) commands collapsed to single lines and that the command path matches the real subcommand name. -## Generated reference docs (man pages and `docs/cli`) +## Generated reference docs (man pages and `docs/manuals/nico-admin-cli`) Two hidden subcommands turn the live clap tree into documentation, so the reference can't drift from the code. Both are `hide = true` (they don't show @@ -234,18 +234,20 @@ in `--help`) and write to a directory you pass with `--out-dir`: - `generate-man` renders a roff man page per command/subcommand via `clap_mangen` (one file each, named by the full path, e.g. - `carbide-admin-cli-vpc-show.1`). Run it with `cargo make gen-man`. -- `generate-cli-docs` builds the `docs/cli` markdown reference. It renders the - same man pages, converts each to GitHub-flavored markdown with **pandoc** - (the `pandoc` *binary* must be on `PATH` — it's installed in the CI build - images), and reorganizes them into one directory per top-level command - (`docs/cli/commands//.md`, with each descendant beside it - as `-.md`). The man page's OPTIONS/SYNOPSIS give each page its - per-flag detail; the `EXAMPLES:` block you write becomes that page's - `## Examples`. Run it with `cargo make gen-cli-docs`. - -The hand-authored pages (`docs/cli/README.md`, `setup.md`, `workflows.md`, -`rest-cli-parity.md`) are editorial and are **not** regenerated — leave them be. + `nico-admin-cli-vpc-show.1`). Run it with `cargo make gen-man`. +- `generate-cli-docs` builds the `docs/manuals/nico-admin-cli` markdown + reference. It renders the same man pages, converts each to GitHub-flavored + markdown with **pandoc** (the `pandoc` *binary* must be on `PATH` — it's + installed in the CI build images), and reorganizes them into one directory per + top-level command + (`docs/manuals/nico-admin-cli/commands//.md`, with each + descendant beside it as `-.md`). The man page's OPTIONS/SYNOPSIS + give each page its per-flag detail; the `EXAMPLES:` block you write becomes + that page's `## Examples`. Run it with `cargo make gen-cli-docs`. + +The hand-authored pages (`docs/manuals/nico-admin-cli/README.md`, `setup.md`, +`workflows.md`, `rest-cli-parity.md`) are editorial and are **not** regenerated +— leave them be. ### Categorizing a new command @@ -261,18 +263,18 @@ Two tests keep the YAML honest: - `no_unknown_commands_in_domain_map` fails if the YAML names a command that no longer exists. -### Keeping `docs/cli` in sync +### Keeping `docs/manuals/nico-admin-cli` in sync -`docs/cli` is committed, so regenerate and commit it whenever you change a -command's help, examples, structure, or domain: +`docs/manuals/nico-admin-cli` is committed, so regenerate and commit it +whenever you change a command's help, examples, structure, or domain: ```bash -cargo make gen-cli-docs # regenerate docs/cli (needs the pandoc binary) +cargo make gen-cli-docs # regenerate docs/manuals/nico-admin-cli (needs the pandoc binary) ``` CI runs `cargo make check-cli-docs`, which runs the two domain tests, then -regenerates and fails on any `git diff` in `docs/cli` — so a forgotten -regeneration (or an uncategorized command) is caught there. +regenerates and fails on any `git diff` in `docs/manuals/nico-admin-cli` — +so a forgotten regeneration (or an uncategorized command) is caught there. ## Error messages @@ -341,7 +343,7 @@ can live with its constraints: pub address: String, ``` ``` -Usage: carbide-admin-cli redfish [OPTIONS] --address
+Usage: nico-admin-cli redfish [OPTIONS] --address
``` With the first row clap does the work — no validation code in `main.rs`, and diff --git a/crates/admin-cli/Cargo.toml b/crates/admin-cli/Cargo.toml index a719306723..6d50524146 100644 --- a/crates/admin-cli/Cargo.toml +++ b/crates/admin-cli/Cargo.toml @@ -15,15 +15,14 @@ # limitations under the License. # [package] -name = "carbide-admin-cli" +name = "nico-admin-cli" version = "0.0.1" edition.workspace = true license.workspace = true authors.workspace = true [[bin]] -# TODO: rename to carbide-admin-cli -name = "carbide-admin-cli" +name = "nico-admin-cli" path = "src/main.rs" [dependencies] diff --git a/crates/admin-cli/cli_domains.yaml b/crates/admin-cli/cli_domains.yaml index a81abac119..396bc26010 100644 --- a/crates/admin-cli/cli_domains.yaml +++ b/crates/admin-cli/cli_domains.yaml @@ -1,6 +1,6 @@ -# Operator-facing grouping of top-level `carbide-admin-cli` commands, used to -# organize the generated CLI reference under docs/cli (run -# `carbide-admin-cli generate-cli-docs`). +# Operator-facing grouping of top-level `nico-admin-cli` commands, used to +# organize the generated CLI reference under docs/manuals/nico-admin-cli (run +# `nico-admin-cli generate-cli-docs`). # # Keyed by domain; each value is the list of command names (as rendered in # --help, e.g. "managed-host", "tenant-key-set") in that domain. When you add a diff --git a/crates/admin-cli/src/attestation/measured_boot/bundle/args.rs b/crates/admin-cli/src/attestation/measured_boot/bundle/args.rs index 3a57391f29..cfe754a042 100644 --- a/crates/admin-cli/src/attestation/measured_boot/bundle/args.rs +++ b/crates/admin-cli/src/attestation/measured_boot/bundle/args.rs @@ -96,11 +96,11 @@ pub enum CmdBundle { EXAMPLES: Create an active bundle for a profile with two PCR values: - $ carbide-admin-cli attestation measured-boot bundle create my-bundle \ + $ nico-admin-cli attestation measured-boot bundle create my-bundle \ 12345678-1234-5678-90ab-cdef01234567 0:abc123,7:def456 Create a bundle in the pending state (awaiting approval): - $ carbide-admin-cli attestation measured-boot bundle create my-bundle \ + $ nico-admin-cli attestation measured-boot bundle create my-bundle \ 12345678-1234-5678-90ab-cdef01234567 0:abc123 --state pending ")] @@ -136,11 +136,11 @@ pub struct Create { EXAMPLES: Delete a bundle by ID: - $ carbide-admin-cli attestation measured-boot bundle delete \ + $ nico-admin-cli attestation measured-boot bundle delete \ 12345678-1234-5678-90ab-cdef01234567 Delete a bundle and purge its journal records: - $ carbide-admin-cli attestation measured-boot bundle delete \ + $ nico-admin-cli attestation measured-boot bundle delete \ 12345678-1234-5678-90ab-cdef01234567 --purge-journals ")] @@ -160,10 +160,10 @@ pub struct Delete { EXAMPLES: Rename a bundle, letting the CLI detect whether the identifier is an ID or name: - $ carbide-admin-cli attestation measured-boot bundle rename old-name new-name + $ nico-admin-cli attestation measured-boot bundle rename old-name new-name Rename a bundle selected explicitly by ID: - $ carbide-admin-cli attestation measured-boot bundle rename \ + $ nico-admin-cli attestation measured-boot bundle rename \ 12345678-1234-5678-90ab-cdef01234567 new-name --is-id ")] @@ -198,14 +198,14 @@ impl IdNameIdentifier for Rename { EXAMPLES: Show all bundles: - $ carbide-admin-cli attestation measured-boot bundle show + $ nico-admin-cli attestation measured-boot bundle show Show one bundle by ID: - $ carbide-admin-cli attestation measured-boot bundle show \ + $ nico-admin-cli attestation measured-boot bundle show \ 12345678-1234-5678-90ab-cdef01234567 --is-id Show one bundle by name: - $ carbide-admin-cli attestation measured-boot bundle show my-bundle --is-name + $ nico-admin-cli attestation measured-boot bundle show my-bundle --is-name ")] pub struct Show { @@ -236,10 +236,10 @@ impl IdNameIdentifier for Show { EXAMPLES: Mark a bundle obsolete (selected by name): - $ carbide-admin-cli attestation measured-boot bundle set-state my-bundle obsolete + $ nico-admin-cli attestation measured-boot bundle set-state my-bundle obsolete Revoke a known-bad bundle by ID: - $ carbide-admin-cli attestation measured-boot bundle set-state \ + $ nico-admin-cli attestation measured-boot bundle set-state \ 12345678-1234-5678-90ab-cdef01234567 revoked --is-id ")] @@ -277,10 +277,10 @@ impl IdNameIdentifier for SetState { EXAMPLES: List metadata for all bundles: - $ carbide-admin-cli attestation measured-boot bundle list all + $ nico-admin-cli attestation measured-boot bundle list all List all machines matching a bundle: - $ carbide-admin-cli attestation measured-boot bundle list machines my-bundle + $ nico-admin-cli attestation measured-boot bundle list machines my-bundle ")] pub enum List { @@ -300,7 +300,7 @@ pub enum List { EXAMPLES: List metadata for all bundles: - $ carbide-admin-cli attestation measured-boot bundle list all + $ nico-admin-cli attestation measured-boot bundle list all ")] pub struct ListAll {} @@ -311,10 +311,10 @@ pub struct ListAll {} EXAMPLES: List all machines matching a bundle by name: - $ carbide-admin-cli attestation measured-boot bundle list machines my-bundle + $ nico-admin-cli attestation measured-boot bundle list machines my-bundle List all machines matching a bundle selected explicitly by ID: - $ carbide-admin-cli attestation measured-boot bundle list machines \ + $ nico-admin-cli attestation measured-boot bundle list machines \ 12345678-1234-5678-90ab-cdef01234567 --is-id ")] @@ -344,7 +344,7 @@ impl IdNameIdentifier for ListMachines { EXAMPLES: Find the closest matching bundle for a report: - $ carbide-admin-cli attestation measured-boot bundle find-closest-match report \ + $ nico-admin-cli attestation measured-boot bundle find-closest-match report \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -358,7 +358,7 @@ pub enum FindClosestMatch { EXAMPLES: Find the closest matching bundle for a report: - $ carbide-admin-cli attestation measured-boot bundle find-closest-match report \ + $ nico-admin-cli attestation measured-boot bundle find-closest-match report \ 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/attestation/measured_boot/journal/args.rs b/crates/admin-cli/src/attestation/measured_boot/journal/args.rs index a0d0fd5657..55b072a478 100644 --- a/crates/admin-cli/src/attestation/measured_boot/journal/args.rs +++ b/crates/admin-cli/src/attestation/measured_boot/journal/args.rs @@ -62,7 +62,7 @@ pub enum CmdJournal { EXAMPLES: Delete a journal entry by ID: - $ carbide-admin-cli attestation measured-boot journal delete \ + $ nico-admin-cli attestation measured-boot journal delete \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -77,10 +77,10 @@ pub struct Delete { EXAMPLES: List all journal entries: - $ carbide-admin-cli attestation measured-boot journal list + $ nico-admin-cli attestation measured-boot journal list List journal entries for a single machine: - $ carbide-admin-cli attestation measured-boot journal list \ + $ nico-admin-cli attestation measured-boot journal list \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -96,10 +96,10 @@ pub struct List { EXAMPLES: Show all journal entries: - $ carbide-admin-cli attestation measured-boot journal show + $ nico-admin-cli attestation measured-boot journal show Show one journal entry by ID: - $ carbide-admin-cli attestation measured-boot journal show \ + $ nico-admin-cli attestation measured-boot journal show \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -115,11 +115,11 @@ pub struct Show { EXAMPLES: Promote a journal entry's report into a bundle: - $ carbide-admin-cli attestation measured-boot journal promote \ + $ nico-admin-cli attestation measured-boot journal promote \ 12345678-1234-5678-90ab-cdef01234567 Promote only specific PCR registers (indices and ranges): - $ carbide-admin-cli attestation measured-boot journal promote \ + $ nico-admin-cli attestation measured-boot journal promote \ 12345678-1234-5678-90ab-cdef01234567 --pcr-registers 0,7,11-14 ")] diff --git a/crates/admin-cli/src/attestation/measured_boot/machine/args.rs b/crates/admin-cli/src/attestation/measured_boot/machine/args.rs index fbd635ea70..46f734cab9 100644 --- a/crates/admin-cli/src/attestation/measured_boot/machine/args.rs +++ b/crates/admin-cli/src/attestation/measured_boot/machine/args.rs @@ -59,7 +59,7 @@ pub enum CmdMachine { EXAMPLES: Send a measurement report (two PCR values) for a mock machine: - $ carbide-admin-cli attestation measured-boot machine attest \ + $ nico-admin-cli attestation measured-boot machine attest \ 12345678-1234-5678-90ab-cdef01234567 0:abc123,7:def456 ")] @@ -83,7 +83,7 @@ pub struct Attest { EXAMPLES: List all mock machines: - $ carbide-admin-cli attestation measured-boot machine list + $ nico-admin-cli attestation measured-boot machine list ")] pub struct List {} @@ -95,10 +95,10 @@ pub struct List {} EXAMPLES: Show all mock machines: - $ carbide-admin-cli attestation measured-boot machine show + $ nico-admin-cli attestation measured-boot machine show Show one mock machine by ID: - $ carbide-admin-cli attestation measured-boot machine show \ + $ nico-admin-cli attestation measured-boot machine show \ 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/attestation/measured_boot/profile/args.rs b/crates/admin-cli/src/attestation/measured_boot/profile/args.rs index 8038a0959a..8639e15904 100644 --- a/crates/admin-cli/src/attestation/measured_boot/profile/args.rs +++ b/crates/admin-cli/src/attestation/measured_boot/profile/args.rs @@ -81,11 +81,11 @@ pub enum CmdProfile { EXAMPLES: Create a profile for a vendor/product pair: - $ carbide-admin-cli attestation measured-boot profile create my-profile dell \ + $ nico-admin-cli attestation measured-boot profile create my-profile dell \ poweredge_r750 Create a profile with extra attributes: - $ carbide-admin-cli attestation measured-boot profile create my-profile dell \ + $ nico-admin-cli attestation measured-boot profile create my-profile dell \ poweredge_r750 --extra-attrs region:us-west,rack:r1 ")] @@ -119,10 +119,10 @@ pub struct Create { EXAMPLES: Delete a profile by name: - $ carbide-admin-cli attestation measured-boot profile delete my-profile + $ nico-admin-cli attestation measured-boot profile delete my-profile Delete a profile selected explicitly by ID: - $ carbide-admin-cli attestation measured-boot profile delete \ + $ nico-admin-cli attestation measured-boot profile delete \ 12345678-1234-5678-90ab-cdef01234567 --is-id ")] @@ -155,10 +155,10 @@ impl IdNameIdentifier for Delete { EXAMPLES: Rename a profile, letting the CLI detect ID vs name: - $ carbide-admin-cli attestation measured-boot profile rename old-name new-name + $ nico-admin-cli attestation measured-boot profile rename old-name new-name Rename a profile selected explicitly by ID: - $ carbide-admin-cli attestation measured-boot profile rename \ + $ nico-admin-cli attestation measured-boot profile rename \ 12345678-1234-5678-90ab-cdef01234567 new-name --is-id ")] @@ -193,14 +193,14 @@ impl IdNameIdentifier for Rename { EXAMPLES: Show all profiles: - $ carbide-admin-cli attestation measured-boot profile show + $ nico-admin-cli attestation measured-boot profile show Show one profile by ID: - $ carbide-admin-cli attestation measured-boot profile show \ + $ nico-admin-cli attestation measured-boot profile show \ 12345678-1234-5678-90ab-cdef01234567 --is-id Show one profile by name: - $ carbide-admin-cli attestation measured-boot profile show my-profile --is-name + $ nico-admin-cli attestation measured-boot profile show my-profile --is-name ")] pub struct Show { @@ -230,13 +230,13 @@ impl IdNameIdentifier for Show { EXAMPLES: List all profiles: - $ carbide-admin-cli attestation measured-boot profile list all + $ nico-admin-cli attestation measured-boot profile list all List all bundles for a profile: - $ carbide-admin-cli attestation measured-boot profile list bundles my-profile + $ nico-admin-cli attestation measured-boot profile list bundles my-profile List all machines for a profile: - $ carbide-admin-cli attestation measured-boot profile list machines my-profile + $ nico-admin-cli attestation measured-boot profile list machines my-profile ")] pub enum List { @@ -262,7 +262,7 @@ pub enum List { EXAMPLES: List all profiles: - $ carbide-admin-cli attestation measured-boot profile list all + $ nico-admin-cli attestation measured-boot profile list all ")] pub struct ListAll {} @@ -273,10 +273,10 @@ pub struct ListAll {} EXAMPLES: List all bundles for a profile by name: - $ carbide-admin-cli attestation measured-boot profile list bundles my-profile + $ nico-admin-cli attestation measured-boot profile list bundles my-profile List all bundles for a profile selected explicitly by ID: - $ carbide-admin-cli attestation measured-boot profile list bundles \ + $ nico-admin-cli attestation measured-boot profile list bundles \ 12345678-1234-5678-90ab-cdef01234567 --is-id ")] @@ -307,10 +307,10 @@ impl IdNameIdentifier for ListBundles { EXAMPLES: List all machines for a profile by name: - $ carbide-admin-cli attestation measured-boot profile list machines my-profile + $ nico-admin-cli attestation measured-boot profile list machines my-profile List all machines for a profile selected explicitly by ID: - $ carbide-admin-cli attestation measured-boot profile list machines \ + $ nico-admin-cli attestation measured-boot profile list machines \ 12345678-1234-5678-90ab-cdef01234567 --is-id ")] diff --git a/crates/admin-cli/src/attestation/measured_boot/report/args.rs b/crates/admin-cli/src/attestation/measured_boot/report/args.rs index ea60e1970f..6171713994 100644 --- a/crates/admin-cli/src/attestation/measured_boot/report/args.rs +++ b/crates/admin-cli/src/attestation/measured_boot/report/args.rs @@ -98,7 +98,7 @@ pub enum CmdReport { EXAMPLES: Create a measurement report for a machine with two PCR values: - $ carbide-admin-cli attestation measured-boot report create \ + $ nico-admin-cli attestation measured-boot report create \ 12345678-1234-5678-90ab-cdef01234567 0:abc123,7:def456 ")] @@ -122,7 +122,7 @@ pub struct Create { EXAMPLES: Delete a report by ID: - $ carbide-admin-cli attestation measured-boot report delete \ + $ nico-admin-cli attestation measured-boot report delete \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -139,11 +139,11 @@ pub struct Delete { EXAMPLES: Promote a report into an active bundle: - $ carbide-admin-cli attestation measured-boot report promote \ + $ nico-admin-cli attestation measured-boot report promote \ 12345678-1234-5678-90ab-cdef01234567 Promote a report using only specific PCR registers: - $ carbide-admin-cli attestation measured-boot report promote \ + $ nico-admin-cli attestation measured-boot report promote \ 12345678-1234-5678-90ab-cdef01234567 --pcr-registers 0,7,11-14 ")] @@ -167,11 +167,11 @@ pub struct Promote { EXAMPLES: Create a revoked bundle from a report: - $ carbide-admin-cli attestation measured-boot report revoke \ + $ nico-admin-cli attestation measured-boot report revoke \ 12345678-1234-5678-90ab-cdef01234567 Revoke using only specific PCR registers: - $ carbide-admin-cli attestation measured-boot report revoke \ + $ nico-admin-cli attestation measured-boot report revoke \ 12345678-1234-5678-90ab-cdef01234567 --pcr-registers 0,7,11-14 ")] @@ -193,14 +193,14 @@ pub struct Revoke { EXAMPLES: Show all reports: - $ carbide-admin-cli attestation measured-boot report show all + $ nico-admin-cli attestation measured-boot report show all Show one report by ID: - $ carbide-admin-cli attestation measured-boot report show id \ + $ nico-admin-cli attestation measured-boot report show id \ 12345678-1234-5678-90ab-cdef01234567 Show all reports for a machine: - $ carbide-admin-cli attestation measured-boot report show machine \ + $ nico-admin-cli attestation measured-boot report show machine \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -221,7 +221,7 @@ pub enum ShowFor { EXAMPLES: Show one report by ID: - $ carbide-admin-cli attestation measured-boot report show id \ + $ nico-admin-cli attestation measured-boot report show id \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -236,7 +236,7 @@ pub struct ShowForId { EXAMPLES: Show all reports for a machine: - $ carbide-admin-cli attestation measured-boot report show machine \ + $ nico-admin-cli attestation measured-boot report show machine \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -251,10 +251,10 @@ pub struct ShowForMachine { EXAMPLES: List all reports: - $ carbide-admin-cli attestation measured-boot report list all + $ nico-admin-cli attestation measured-boot report list all List all reports for a machine: - $ carbide-admin-cli attestation measured-boot report list machines \ + $ nico-admin-cli attestation measured-boot report list machines \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -275,7 +275,7 @@ pub enum List { EXAMPLES: List all reports: - $ carbide-admin-cli attestation measured-boot report list all + $ nico-admin-cli attestation measured-boot report list all ")] pub struct ListAll {} @@ -286,7 +286,7 @@ pub struct ListAll {} EXAMPLES: List all reports for a machine: - $ carbide-admin-cli attestation measured-boot report list machines \ + $ nico-admin-cli attestation measured-boot report list machines \ 12345678-1234-5678-90ab-cdef01234567 ")] @@ -301,7 +301,7 @@ pub struct ListMachines { EXAMPLES: Find reports matching a set of PCR register values: - $ carbide-admin-cli attestation measured-boot report match 0:abc123,7:def456 + $ nico-admin-cli attestation measured-boot report match 0:abc123,7:def456 ")] pub struct Match { diff --git a/crates/admin-cli/src/attestation/measured_boot/site/args.rs b/crates/admin-cli/src/attestation/measured_boot/site/args.rs index 9a78740328..eb29075346 100644 --- a/crates/admin-cli/src/attestation/measured_boot/site/args.rs +++ b/crates/admin-cli/src/attestation/measured_boot/site/args.rs @@ -66,7 +66,7 @@ pub enum CmdSite { EXAMPLES: Import a site model (profiles + bundles) from a JSON file: - $ carbide-admin-cli attestation measured-boot site import ./site.json + $ nico-admin-cli attestation measured-boot site import ./site.json ")] pub struct Import { @@ -80,10 +80,10 @@ pub struct Import { EXAMPLES: Export the site model to stdout: - $ carbide-admin-cli attestation measured-boot site export + $ nico-admin-cli attestation measured-boot site export Export the site model to a file: - $ carbide-admin-cli attestation measured-boot site export --path ./site.json + $ nico-admin-cli attestation measured-boot site export --path ./site.json ")] pub struct Export { @@ -97,14 +97,14 @@ pub struct Export { EXAMPLES: Approve a machine for one-shot auto-promotion of its measurements: - $ carbide-admin-cli attestation measured-boot site trusted-machine approve \ + $ nico-admin-cli attestation measured-boot site trusted-machine approve \ 12345678-1234-5678-90ab-cdef01234567 oneshot List all active machine approvals: - $ carbide-admin-cli attestation measured-boot site trusted-machine list + $ nico-admin-cli attestation measured-boot site trusted-machine list Remove an approval by machine ID: - $ carbide-admin-cli attestation measured-boot site trusted-machine remove \ + $ nico-admin-cli attestation measured-boot site trusted-machine remove \ by-machine-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -132,14 +132,14 @@ pub enum TrustedMachine { EXAMPLES: Approve a profile for persistent auto-promotion of matching machines' measurements: - $ carbide-admin-cli attestation measured-boot site trusted-profile approve \ + $ nico-admin-cli attestation measured-boot site trusted-profile approve \ 12345678-1234-5678-90ab-cdef01234567 persist List all active profile approvals: - $ carbide-admin-cli attestation measured-boot site trusted-profile list + $ nico-admin-cli attestation measured-boot site trusted-profile list Remove an approval by profile ID: - $ carbide-admin-cli attestation measured-boot site trusted-profile remove \ + $ nico-admin-cli attestation measured-boot site trusted-profile remove \ by-profile-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -168,11 +168,11 @@ pub enum TrustedProfile { EXAMPLES: Approve a single machine for one-shot auto-promotion: - $ carbide-admin-cli attestation measured-boot site trusted-machine approve \ + $ nico-admin-cli attestation measured-boot site trusted-machine approve \ 12345678-1234-5678-90ab-cdef01234567 oneshot Approve all machines persistently, restricted to specific PCR registers, with a comment: - $ carbide-admin-cli attestation measured-boot site trusted-machine approve '*' \ + $ nico-admin-cli attestation measured-boot site trusted-machine approve '*' \ persist --pcr-registers 0,7 --comments \"trusted fleet\" ")] @@ -201,11 +201,11 @@ pub struct ApproveMachine { EXAMPLES: Remove a machine approval by approval ID: - $ carbide-admin-cli attestation measured-boot site trusted-machine remove \ + $ nico-admin-cli attestation measured-boot site trusted-machine remove \ by-approval-id 12345678-1234-5678-90ab-cdef01234567 Remove a machine approval by machine ID: - $ carbide-admin-cli attestation measured-boot site trusted-machine remove \ + $ nico-admin-cli attestation measured-boot site trusted-machine remove \ by-machine-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -224,7 +224,7 @@ pub enum RemoveMachine { EXAMPLES: Remove a machine approval by approval ID: - $ carbide-admin-cli attestation measured-boot site trusted-machine remove \ + $ nico-admin-cli attestation measured-boot site trusted-machine remove \ by-approval-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -240,7 +240,7 @@ pub struct RemoveMachineByApprovalId { EXAMPLES: Remove a machine approval by machine ID: - $ carbide-admin-cli attestation measured-boot site trusted-machine remove \ + $ nico-admin-cli attestation measured-boot site trusted-machine remove \ by-machine-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -255,7 +255,7 @@ pub struct RemoveMachineByMachineId { EXAMPLES: List all active machine approvals: - $ carbide-admin-cli attestation measured-boot site trusted-machine list + $ nico-admin-cli attestation measured-boot site trusted-machine list ")] pub struct ListMachines {} @@ -267,11 +267,11 @@ pub struct ListMachines {} EXAMPLES: Approve a profile for one-shot auto-promotion: - $ carbide-admin-cli attestation measured-boot site trusted-profile approve \ + $ nico-admin-cli attestation measured-boot site trusted-profile approve \ 12345678-1234-5678-90ab-cdef01234567 oneshot Approve a profile persistently, restricted to specific PCR registers, with a comment: - $ carbide-admin-cli attestation measured-boot site trusted-profile approve \ + $ nico-admin-cli attestation measured-boot site trusted-profile approve \ 12345678-1234-5678-90ab-cdef01234567 persist --pcr-registers 0,7 --comments \"trusted SKU\" ")] @@ -300,11 +300,11 @@ pub struct ApproveProfile { EXAMPLES: Remove a profile approval by approval ID: - $ carbide-admin-cli attestation measured-boot site trusted-profile remove \ + $ nico-admin-cli attestation measured-boot site trusted-profile remove \ by-approval-id 12345678-1234-5678-90ab-cdef01234567 Remove a profile approval by profile ID: - $ carbide-admin-cli attestation measured-boot site trusted-profile remove \ + $ nico-admin-cli attestation measured-boot site trusted-profile remove \ by-profile-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -323,7 +323,7 @@ pub enum RemoveProfile { EXAMPLES: Remove a profile approval by approval ID: - $ carbide-admin-cli attestation measured-boot site trusted-profile remove \ + $ nico-admin-cli attestation measured-boot site trusted-profile remove \ by-approval-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -339,7 +339,7 @@ pub struct RemoveProfileByApprovalId { EXAMPLES: Remove a profile approval by profile ID: - $ carbide-admin-cli attestation measured-boot site trusted-profile remove \ + $ nico-admin-cli attestation measured-boot site trusted-profile remove \ by-profile-id 12345678-1234-5678-90ab-cdef01234567 ")] @@ -354,7 +354,7 @@ pub struct RemoveProfileByProfileId { EXAMPLES: List all active profile approvals: - $ carbide-admin-cli attestation measured-boot site trusted-profile list + $ nico-admin-cli attestation measured-boot site trusted-profile list ")] pub struct ListProfiles {} diff --git a/crates/admin-cli/src/attestation/spdm/cancel/args.rs b/crates/admin-cli/src/attestation/spdm/cancel/args.rs index 5fcc55a738..6380267485 100644 --- a/crates/admin-cli/src/attestation/spdm/cancel/args.rs +++ b/crates/admin-cli/src/attestation/spdm/cancel/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Cancel in-progress SPDM attestation for a machine: - $ carbide-admin-cli attestation spdm cancel 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli attestation spdm cancel 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/attestation/spdm/get/args.rs b/crates/admin-cli/src/attestation/spdm/get/args.rs index c60fe5dbfb..732c84d456 100644 --- a/crates/admin-cli/src/attestation/spdm/get/args.rs +++ b/crates/admin-cli/src/attestation/spdm/get/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Get the SPDM attestation status for a machine: - $ carbide-admin-cli attestation spdm get 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli attestation spdm get 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/attestation/spdm/list/args.rs b/crates/admin-cli/src/attestation/spdm/list/args.rs index 6a7df9d87f..e5565cf058 100644 --- a/crates/admin-cli/src/attestation/spdm/list/args.rs +++ b/crates/admin-cli/src/attestation/spdm/list/args.rs @@ -23,7 +23,7 @@ use clap::{Parser, ValueEnum}; EXAMPLES: List all SPDM attestations recorded for a machine: - $ carbide-admin-cli attestation spdm list 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli attestation spdm list 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/attestation/spdm/trigger/args.rs b/crates/admin-cli/src/attestation/spdm/trigger/args.rs index e990a8bcd0..6e7314348f 100644 --- a/crates/admin-cli/src/attestation/spdm/trigger/args.rs +++ b/crates/admin-cli/src/attestation/spdm/trigger/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Trigger SPDM attestation for a machine with a 60-second Redfish timeout: - $ carbide-admin-cli attestation spdm trigger 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli attestation spdm trigger 12345678-1234-5678-90ab-cdef01234567 \ --redfish-timeout-secs 60 ")] diff --git a/crates/admin-cli/src/bmc_machine/admin_power_control/args.rs b/crates/admin-cli/src/bmc_machine/admin_power_control/args.rs index 838b4e81ae..9ccc1e90d1 100644 --- a/crates/admin-cli/src/bmc_machine/admin_power_control/args.rs +++ b/crates/admin-cli/src/bmc_machine/admin_power_control/args.rs @@ -25,19 +25,19 @@ use crate::bmc_machine::common::AdminPowerControlAction; EXAMPLES: Power a machine on: - $ carbide-admin-cli bmc-machine admin-power-control \ + $ nico-admin-cli bmc-machine admin-power-control \ --machine 12345678-1234-5678-90ab-cdef01234567 --action on Gracefully shut a machine down: - $ carbide-admin-cli bmc-machine admin-power-control \ + $ nico-admin-cli bmc-machine admin-power-control \ --machine 12345678-1234-5678-90ab-cdef01234567 --action graceful-shutdown Force a machine off (immediate, no OS shutdown): - $ carbide-admin-cli bmc-machine admin-power-control \ + $ nico-admin-cli bmc-machine admin-power-control \ --machine 12345678-1234-5678-90ab-cdef01234567 --action force-off Gracefully restart a machine: - $ carbide-admin-cli bmc-machine admin-power-control \ + $ nico-admin-cli bmc-machine admin-power-control \ --machine 12345678-1234-5678-90ab-cdef01234567 --action graceful-restart ")] diff --git a/crates/admin-cli/src/bmc_machine/bmc_reset/args.rs b/crates/admin-cli/src/bmc_machine/bmc_reset/args.rs index d4b2efada9..fbf727bec3 100644 --- a/crates/admin-cli/src/bmc_machine/bmc_reset/args.rs +++ b/crates/admin-cli/src/bmc_machine/bmc_reset/args.rs @@ -23,10 +23,10 @@ use rpc::forge as forgerpc; EXAMPLES: Reset the BMC of a machine via Redfish: - $ carbide-admin-cli bmc-machine bmc-reset --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli bmc-machine bmc-reset --machine 12345678-1234-5678-90ab-cdef01234567 Reset the BMC using ipmitool instead of Redfish: - $ carbide-admin-cli bmc-machine bmc-reset --machine 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli bmc-machine bmc-reset --machine 12345678-1234-5678-90ab-cdef01234567 \ --use-ipmitool ")] diff --git a/crates/admin-cli/src/bmc_machine/create_bmc_user/args.rs b/crates/admin-cli/src/bmc_machine/create_bmc_user/args.rs index 01c382941f..ae106b09d5 100644 --- a/crates/admin-cli/src/bmc_machine/create_bmc_user/args.rs +++ b/crates/admin-cli/src/bmc_machine/create_bmc_user/args.rs @@ -24,19 +24,19 @@ use rpc::forge as forgerpc; EXAMPLES: Create a BMC user, targeting the BMC by machine id: - $ carbide-admin-cli bmc-machine create-bmc-user \ + $ nico-admin-cli bmc-machine create-bmc-user \ --machine 12345678-1234-5678-90ab-cdef01234567 --username admin --password mynewpassword Target the BMC by IP address: - $ carbide-admin-cli bmc-machine create-bmc-user \ + $ nico-admin-cli bmc-machine create-bmc-user \ --ip-address 192.0.2.20 --username admin --password mynewpassword Target the BMC by MAC address: - $ carbide-admin-cli bmc-machine create-bmc-user \ + $ nico-admin-cli bmc-machine create-bmc-user \ --mac-address 00:11:22:33:44:55 --username admin --password mynewpassword Create a read-only user by setting an explicit role: - $ carbide-admin-cli bmc-machine create-bmc-user \ + $ nico-admin-cli bmc-machine create-bmc-user \ --machine 12345678-1234-5678-90ab-cdef01234567 --username admin --password mynewpassword \ --role-id readonly diff --git a/crates/admin-cli/src/bmc_machine/delete_bmc_user/args.rs b/crates/admin-cli/src/bmc_machine/delete_bmc_user/args.rs index d344df52fb..8216cbcb1a 100644 --- a/crates/admin-cli/src/bmc_machine/delete_bmc_user/args.rs +++ b/crates/admin-cli/src/bmc_machine/delete_bmc_user/args.rs @@ -24,14 +24,14 @@ use rpc::forge as forgerpc; EXAMPLES: Delete a BMC user, targeting the BMC by machine id: - $ carbide-admin-cli bmc-machine delete-bmc-user \ + $ nico-admin-cli bmc-machine delete-bmc-user \ --machine 12345678-1234-5678-90ab-cdef01234567 --username admin Target the BMC by IP address: - $ carbide-admin-cli bmc-machine delete-bmc-user --ip-address 192.0.2.20 --username admin + $ nico-admin-cli bmc-machine delete-bmc-user --ip-address 192.0.2.20 --username admin Target the BMC by MAC address: - $ carbide-admin-cli bmc-machine delete-bmc-user --mac-address 00:11:22:33:44:55 --username admin + $ nico-admin-cli bmc-machine delete-bmc-user --mac-address 00:11:22:33:44:55 --username admin ")] pub struct Args { diff --git a/crates/admin-cli/src/bmc_machine/enable_infinite_boot/args.rs b/crates/admin-cli/src/bmc_machine/enable_infinite_boot/args.rs index c6340f8b18..f3fe7e8787 100644 --- a/crates/admin-cli/src/bmc_machine/enable_infinite_boot/args.rs +++ b/crates/admin-cli/src/bmc_machine/enable_infinite_boot/args.rs @@ -27,11 +27,11 @@ use crate::bmc_machine::common::InfiniteBootArgs; EXAMPLES: Enable infinite boot on a machine: - $ carbide-admin-cli bmc-machine enable-infinite-boot \ + $ nico-admin-cli bmc-machine enable-infinite-boot \ --machine 12345678-1234-5678-90ab-cdef01234567 Enable infinite boot and reboot to apply the BIOS change: - $ carbide-admin-cli bmc-machine enable-infinite-boot \ + $ nico-admin-cli bmc-machine enable-infinite-boot \ --machine 12345678-1234-5678-90ab-cdef01234567 --reboot ")] diff --git a/crates/admin-cli/src/bmc_machine/is_infinite_boot_enabled/args.rs b/crates/admin-cli/src/bmc_machine/is_infinite_boot_enabled/args.rs index 16a2d83426..ded3be8d35 100644 --- a/crates/admin-cli/src/bmc_machine/is_infinite_boot_enabled/args.rs +++ b/crates/admin-cli/src/bmc_machine/is_infinite_boot_enabled/args.rs @@ -28,7 +28,7 @@ use crate::bmc_machine::common::InfiniteBootArgs; EXAMPLES: Check whether infinite boot is enabled on a machine: - $ carbide-admin-cli bmc-machine is-infinite-boot-enabled \ + $ nico-admin-cli bmc-machine is-infinite-boot-enabled \ --machine 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/bmc_machine/lockdown/args.rs b/crates/admin-cli/src/bmc_machine/lockdown/args.rs index fd95a98f4c..906d437733 100644 --- a/crates/admin-cli/src/bmc_machine/lockdown/args.rs +++ b/crates/admin-cli/src/bmc_machine/lockdown/args.rs @@ -23,15 +23,15 @@ use clap::Parser; EXAMPLES: Enable lockdown on a machine: - $ carbide-admin-cli bmc-machine lockdown \ + $ nico-admin-cli bmc-machine lockdown \ --machine 12345678-1234-5678-90ab-cdef01234567 --enable Disable lockdown on a machine: - $ carbide-admin-cli bmc-machine lockdown \ + $ nico-admin-cli bmc-machine lockdown \ --machine 12345678-1234-5678-90ab-cdef01234567 --disable Enable lockdown and reboot to apply the change: - $ carbide-admin-cli bmc-machine lockdown \ + $ nico-admin-cli bmc-machine lockdown \ --machine 12345678-1234-5678-90ab-cdef01234567 --enable --reboot ")] diff --git a/crates/admin-cli/src/bmc_machine/lockdown_status/args.rs b/crates/admin-cli/src/bmc_machine/lockdown_status/args.rs index 6aa4b7433c..57e5bc65f0 100644 --- a/crates/admin-cli/src/bmc_machine/lockdown_status/args.rs +++ b/crates/admin-cli/src/bmc_machine/lockdown_status/args.rs @@ -24,7 +24,7 @@ use rpc::forge as forgerpc; EXAMPLES: Check the lockdown status of a machine: - $ carbide-admin-cli bmc-machine lockdown-status \ + $ nico-admin-cli bmc-machine lockdown-status \ --machine 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/boot_override/clear/args.rs b/crates/admin-cli/src/boot_override/clear/args.rs index d70835182f..4d2ff85be7 100644 --- a/crates/admin-cli/src/boot_override/clear/args.rs +++ b/crates/admin-cli/src/boot_override/clear/args.rs @@ -28,7 +28,7 @@ use crate::boot_override::common::BootOverride; EXAMPLES: Clear the boot override on a machine interface: - $ carbide-admin-cli boot-override clear 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli boot-override clear 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/boot_override/get/args.rs b/crates/admin-cli/src/boot_override/get/args.rs index 1a0abd1ab0..e8cb914d54 100644 --- a/crates/admin-cli/src/boot_override/get/args.rs +++ b/crates/admin-cli/src/boot_override/get/args.rs @@ -28,7 +28,7 @@ use crate::boot_override::common::BootOverride; EXAMPLES: Show the boot override for a machine interface: - $ carbide-admin-cli boot-override get 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli boot-override get 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/boot_override/set/args.rs b/crates/admin-cli/src/boot_override/set/args.rs index d79a8c2872..a176899d47 100644 --- a/crates/admin-cli/src/boot_override/set/args.rs +++ b/crates/admin-cli/src/boot_override/set/args.rs @@ -26,15 +26,15 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Set a custom iPXE script for a machine interface: - $ carbide-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 \ --custom-pxe ./boot.ipxe Set custom user-data for a machine interface: - $ carbide-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 \ --custom-user-data ./user-data.yaml Set both a custom iPXE script and custom user-data: - $ carbide-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 \ --custom-pxe ./boot.ipxe --custom-user-data ./user-data.yaml ")] diff --git a/crates/admin-cli/src/browse/nmxc/args.rs b/crates/admin-cli/src/browse/nmxc/args.rs index 67a0798f6c..9f2636b9fc 100644 --- a/crates/admin-cli/src/browse/nmxc/args.rs +++ b/crates/admin-cli/src/browse/nmxc/args.rs @@ -47,13 +47,13 @@ impl From for forgerpc::NmxcBrowseOperation { EXAMPLES: List the GPUs on a chassis via NMX-C: - $ carbide-admin-cli browse nmxc --chassis-serial 1234567890 --operation gpu-info-list + $ nico-admin-cli browse nmxc --chassis-serial 1234567890 --operation gpu-info-list List the compute nodes on a chassis: - $ carbide-admin-cli browse nmxc --chassis-serial 1234567890 --operation compute-node-info-list + $ nico-admin-cli browse nmxc --chassis-serial 1234567890 --operation compute-node-info-list Get info for a specific GPU UID: - $ carbide-admin-cli browse nmxc --chassis-serial 1234567890 --operation gpu-info --gpu-uid 42 + $ nico-admin-cli browse nmxc --chassis-serial 1234567890 --operation gpu-info --gpu-uid 42 ")] pub struct Args { diff --git a/crates/admin-cli/src/browse/redfish/args.rs b/crates/admin-cli/src/browse/redfish/args.rs index f3dc0c3d9c..a5c0798300 100644 --- a/crates/admin-cli/src/browse/redfish/args.rs +++ b/crates/admin-cli/src/browse/redfish/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Browse a Redfish resource tree via the API server (no BMC --address needed): - $ carbide-admin-cli browse redfish --uri /redfish/v1/Systems + $ nico-admin-cli browse redfish --uri /redfish/v1/Systems ")] pub struct Args { diff --git a/crates/admin-cli/src/browse/ufm/args.rs b/crates/admin-cli/src/browse/ufm/args.rs index ba3e2211ee..d3ccabf9d0 100644 --- a/crates/admin-cli/src/browse/ufm/args.rs +++ b/crates/admin-cli/src/browse/ufm/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Browse a UFM fabric path via the API server (no BMC --address needed): - $ carbide-admin-cli browse ufm --fabric-id default --path /ufmRest/resources/systems + $ nico-admin-cli browse ufm --fabric-id default --path /ufmRest/resources/systems ")] pub struct Args { diff --git a/crates/admin-cli/src/cfg/cli_options.rs b/crates/admin-cli/src/cfg/cli_options.rs index 6b928f8eca..3df4ffc47c 100644 --- a/crates/admin-cli/src/cfg/cli_options.rs +++ b/crates/admin-cli/src/cfg/cli_options.rs @@ -31,13 +31,13 @@ use crate::{ }; #[derive(Parser, Debug)] -#[clap(name = "carbide-admin-cli")] +#[clap(name = "nico-admin-cli")] #[clap(author = "https://github.com/NVIDIA/ncx-infra-controller-core")] pub struct CliOptions { #[clap( long, default_value = "false", - help = "Print version number of carbide-admin-cli and exit. For API server version see 'version' command." + help = "Print version number of nico-admin-cli and exit. For API server version see 'version' command." )] pub version: bool, @@ -202,12 +202,15 @@ pub enum CliCommand { ExtensionService(extension_service::Cmd), #[clap(about = "Firmware related actions", subcommand)] Firmware(firmware::Cmd), - #[clap(about = "Regenerate the docs/cli markdown reference", hide = true)] + #[clap( + about = "Regenerate the docs/manuals/nico-admin-cli markdown reference", + hide = true + )] GenerateCliDocs(generate_docs::Cmd), #[clap(about = "Generate man pages for the CLI", hide = true)] GenerateMan(generate_man::Cmd), #[clap( - about = "Generate shell autocomplete. Source the output of this command: `source <(carbide-admin-cli generate-shell-complete bash)`" + about = "Generate shell autocomplete. Source the output of this command: `source <(nico-admin-cli generate-shell-complete bash)`" )] GenerateShellComplete(generate_shell_complete::Cmd), #[clap(about = "Host specific handling", subcommand)] @@ -373,7 +376,7 @@ impl CliOptions { // CLI documentation domains // ============================================================================= // -// The generated CLI reference (docs/cli) groups top-level commands into four +// The generated CLI reference (docs/manuals/nico-admin-cli) groups top-level commands into four // operator-facing domains. clap has no native way to categorize subcommands in // `--help`, so the grouping lives in `cli_domains.yaml` (at the crate root) as // the single source of truth and is consumed by the `generate-cli-docs` @@ -462,7 +465,7 @@ mod tests { // Fails if a visible top-level command is missing from cli_domains.yaml. // When someone adds a new command, this points them at the YAML so the - // generated docs (docs/cli) stay grouped by domain. + // generated docs (docs/manuals/nico-admin-cli) stay grouped by domain. #[test] fn every_command_has_a_domain() { let missing: Vec = visible_command_names() diff --git a/crates/admin-cli/src/component_manager/power_control/args.rs b/crates/admin-cli/src/component_manager/power_control/args.rs index a9e5577f18..49ac0f1a9a 100644 --- a/crates/admin-cli/src/component_manager/power_control/args.rs +++ b/crates/admin-cli/src/component_manager/power_control/args.rs @@ -24,15 +24,15 @@ use crate::component_manager::common::{PowerActionArg, PowerControlTargetArgs}; EXAMPLES: Power on a switch: - $ carbide-admin-cli component-manager component-power-control switch \ + $ nico-admin-cli component-manager component-power-control switch \ --switch-id 12345678-1234-5678-90ab-cdef01234567 --action on Force off a compute tray: - $ carbide-admin-cli component-manager component-power-control compute-tray \ + $ nico-admin-cli component-manager component-power-control compute-tray \ --machine-id 12345678-1234-5678-90ab-cdef01234567 --action force-off AC power-cycle a power shelf: - $ carbide-admin-cli component-manager component-power-control power-shelf \ + $ nico-admin-cli component-manager component-power-control power-shelf \ --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 --action ac-powercycle ")] diff --git a/crates/admin-cli/src/component_manager/status/args.rs b/crates/admin-cli/src/component_manager/status/args.rs index 2753e6b48b..197e3f186d 100644 --- a/crates/admin-cli/src/component_manager/status/args.rs +++ b/crates/admin-cli/src/component_manager/status/args.rs @@ -24,15 +24,15 @@ use crate::component_manager::common::DeviceTargetArgs; EXAMPLES: Get firmware update status for switches: - $ carbide-admin-cli component-manager get-firmware-update-status switch \ + $ nico-admin-cli component-manager get-firmware-update-status switch \ --switch-id 12345678-1234-5678-90ab-cdef01234567 Get status for several compute trays at once: - $ carbide-admin-cli component-manager get-firmware-update-status compute-tray \ + $ nico-admin-cli component-manager get-firmware-update-status compute-tray \ --machine-id 12345678-1234-5678-90ab-cdef01234567,abcdef01-2345-6789-abcd-ef0123456789 Get status for an entire rack: - $ carbide-admin-cli component-manager get-firmware-update-status rack \ + $ nico-admin-cli component-manager get-firmware-update-status rack \ --rack-id 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/component_manager/update_firmware/args.rs b/crates/admin-cli/src/component_manager/update_firmware/args.rs index 64fdc26475..f52468c4a1 100644 --- a/crates/admin-cli/src/component_manager/update_firmware/args.rs +++ b/crates/admin-cli/src/component_manager/update_firmware/args.rs @@ -30,25 +30,25 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Queue firmware on NVLink switches from a target version: - $ carbide-admin-cli component-manager update-firmware switch \ + $ nico-admin-cli component-manager update-firmware switch \ --switch-id 12345678-1234-5678-90ab-cdef01234567 --target-version fw-1.2.3 Update only specific switch components, forcing the update: - $ carbide-admin-cli component-manager update-firmware switch \ + $ nico-admin-cli component-manager update-firmware switch \ --switch-id 12345678-1234-5678-90ab-cdef01234567 --component bmc,bios --force-update \ --target-version fw-1.2.3 Queue firmware on compute trays from an RMS SOT JSON file: - $ carbide-admin-cli component-manager update-firmware compute-tray \ + $ nico-admin-cli component-manager update-firmware compute-tray \ --machine-id 12345678-1234-5678-90ab-cdef01234567 --sot-json-file ./sot.json \ --access-token mytoken Queue firmware on power shelves: - $ carbide-admin-cli component-manager update-firmware power-shelf \ + $ nico-admin-cli component-manager update-firmware power-shelf \ --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 --target-version fw-1.2.3 Queue firmware on all eligible devices in a rack: - $ carbide-admin-cli component-manager update-firmware rack \ + $ nico-admin-cli component-manager update-firmware rack \ --rack-id 12345678-1234-5678-90ab-cdef01234567 --target-version fw-1.2.3 ")] diff --git a/crates/admin-cli/src/component_manager/versions/args.rs b/crates/admin-cli/src/component_manager/versions/args.rs index e994ede54b..2dd950570c 100644 --- a/crates/admin-cli/src/component_manager/versions/args.rs +++ b/crates/admin-cli/src/component_manager/versions/args.rs @@ -24,15 +24,15 @@ use crate::component_manager::common::DeviceTargetArgs; EXAMPLES: List available firmware versions for switches: - $ carbide-admin-cli component-manager get-firmware-versions switch \ + $ nico-admin-cli component-manager get-firmware-versions switch \ --switch-id 12345678-1234-5678-90ab-cdef01234567 List versions for power shelves: - $ carbide-admin-cli component-manager get-firmware-versions power-shelf \ + $ nico-admin-cli component-manager get-firmware-versions power-shelf \ --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 List versions for an entire rack: - $ carbide-admin-cli component-manager get-firmware-versions rack \ + $ nico-admin-cli component-manager get-firmware-versions rack \ --rack-id 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/compute_allocation/create/args.rs b/crates/admin-cli/src/compute_allocation/create/args.rs index 8ee1a48851..dc4a12a8c3 100644 --- a/crates/admin-cli/src/compute_allocation/create/args.rs +++ b/crates/admin-cli/src/compute_allocation/create/args.rs @@ -26,11 +26,11 @@ use crate::errors::CarbideCliError; EXAMPLES: Create a compute allocation: - $ carbide-admin-cli compute-allocation create --tenant-organization-id fds34511233a \ + $ nico-admin-cli compute-allocation create --tenant-organization-id fds34511233a \ --instance-type-id DGX-H100-640GB --count 8 Create a named, labelled allocation with an explicit ID: - $ carbide-admin-cli compute-allocation create --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli compute-allocation create --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a --instance-type-id DGX-H100-640GB --count 8 \ --name \"training-pool\" --labels '{\"team\":\"research\"}' diff --git a/crates/admin-cli/src/compute_allocation/delete/args.rs b/crates/admin-cli/src/compute_allocation/delete/args.rs index dc916758a2..61436da539 100644 --- a/crates/admin-cli/src/compute_allocation/delete/args.rs +++ b/crates/admin-cli/src/compute_allocation/delete/args.rs @@ -24,7 +24,7 @@ use clap::Parser; EXAMPLES: Delete a compute allocation: - $ carbide-admin-cli compute-allocation delete --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli compute-allocation delete --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a ")] diff --git a/crates/admin-cli/src/compute_allocation/show/args.rs b/crates/admin-cli/src/compute_allocation/show/args.rs index 9c89f34c54..9dc21478d3 100644 --- a/crates/admin-cli/src/compute_allocation/show/args.rs +++ b/crates/admin-cli/src/compute_allocation/show/args.rs @@ -24,16 +24,16 @@ use clap::Parser; EXAMPLES: Show all compute allocations: - $ carbide-admin-cli compute-allocation show + $ nico-admin-cli compute-allocation show Show one compute allocation by ID: - $ carbide-admin-cli compute-allocation show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli compute-allocation show --id 12345678-1234-5678-90ab-cdef01234567 Show allocations for one tenant: - $ carbide-admin-cli compute-allocation show --tenant-organization-id fds34511233a + $ nico-admin-cli compute-allocation show --tenant-organization-id fds34511233a Filter by instance type: - $ carbide-admin-cli compute-allocation show --instance-type-id DGX-H100-640GB + $ nico-admin-cli compute-allocation show --instance-type-id DGX-H100-640GB ")] pub struct Args { diff --git a/crates/admin-cli/src/compute_allocation/update/args.rs b/crates/admin-cli/src/compute_allocation/update/args.rs index 1ba715def2..f8fc9a5714 100644 --- a/crates/admin-cli/src/compute_allocation/update/args.rs +++ b/crates/admin-cli/src/compute_allocation/update/args.rs @@ -23,15 +23,15 @@ use clap::Parser; EXAMPLES: Change the allocated count: - $ carbide-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a --count 16 Rename and re-describe an allocation: - $ carbide-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a --name \"prod-pool\" --description \"Production capacity\" Replace labels with optimistic-concurrency check on version: - $ carbide-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a --labels '{\"team\":\"research\"}' --version 3 ")] diff --git a/crates/admin-cli/src/credential/add_bmc/args.rs b/crates/admin-cli/src/credential/add_bmc/args.rs index ab70c9d1cd..be6e808a02 100644 --- a/crates/admin-cli/src/credential/add_bmc/args.rs +++ b/crates/admin-cli/src/credential/add_bmc/args.rs @@ -27,10 +27,10 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Add the site-wide BMC root credential: - $ carbide-admin-cli credential add-bmc --kind=site-wide-root --username admin --password mypassword + $ nico-admin-cli credential add-bmc --kind=site-wide-root --username admin --password mypassword Add a per-BMC root credential for a specific MAC address: - $ carbide-admin-cli credential add-bmc --kind=bmc-root --username admin --password mypassword \ + $ nico-admin-cli credential add-bmc --kind=bmc-root --username admin --password mypassword \ --mac-address 00:11:22:33:44:55 ")] diff --git a/crates/admin-cli/src/credential/add_dpu_factory_default/args.rs b/crates/admin-cli/src/credential/add_dpu_factory_default/args.rs index d0ea191169..60fa98ec4f 100644 --- a/crates/admin-cli/src/credential/add_dpu_factory_default/args.rs +++ b/crates/admin-cli/src/credential/add_dpu_factory_default/args.rs @@ -23,7 +23,7 @@ use rpc::{CredentialType, forge as forgerpc}; EXAMPLES: Add the factory-default DPU BMC credential: - $ carbide-admin-cli credential add-dpu-factory-default --username admin --password mypassword + $ nico-admin-cli credential add-dpu-factory-default --username admin --password mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/add_host_factory_default/args.rs b/crates/admin-cli/src/credential/add_host_factory_default/args.rs index fa3cea2d37..4bd7c9e552 100644 --- a/crates/admin-cli/src/credential/add_host_factory_default/args.rs +++ b/crates/admin-cli/src/credential/add_host_factory_default/args.rs @@ -23,7 +23,7 @@ use rpc::{CredentialType, forge as forgerpc}; EXAMPLES: Add the factory-default host BMC credential for a vendor: - $ carbide-admin-cli credential add-host-factory-default --vendor nvidia \ + $ nico-admin-cli credential add-host-factory-default --vendor nvidia \ --username admin --password mypassword ")] diff --git a/crates/admin-cli/src/credential/add_nmxm/args.rs b/crates/admin-cli/src/credential/add_nmxm/args.rs index 9458b943c1..96f15ae218 100644 --- a/crates/admin-cli/src/credential/add_nmxm/args.rs +++ b/crates/admin-cli/src/credential/add_nmxm/args.rs @@ -23,7 +23,7 @@ use rpc::{CredentialType, forge as forgerpc}; EXAMPLES: Add an NMX-M credential: - $ carbide-admin-cli credential add-nmx-m --username admin --password mypassword + $ nico-admin-cli credential add-nmx-m --username admin --password mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/add_uefi/args.rs b/crates/admin-cli/src/credential/add_uefi/args.rs index aabdd9c06a..3bbbc64877 100644 --- a/crates/admin-cli/src/credential/add_uefi/args.rs +++ b/crates/admin-cli/src/credential/add_uefi/args.rs @@ -26,10 +26,10 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Set the site-wide DPU UEFI default password: - $ carbide-admin-cli credential add-uefi --kind=dpu --password=mynewpassword + $ nico-admin-cli credential add-uefi --kind=dpu --password=mynewpassword Set the site-wide host UEFI default password: - $ carbide-admin-cli credential add-uefi --kind=host --password=mynewpassword + $ nico-admin-cli credential add-uefi --kind=host --password=mynewpassword ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/add_ufm/args.rs b/crates/admin-cli/src/credential/add_ufm/args.rs index 9b4b50a544..79c7876d96 100644 --- a/crates/admin-cli/src/credential/add_ufm/args.rs +++ b/crates/admin-cli/src/credential/add_ufm/args.rs @@ -26,7 +26,7 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Add a UFM credential with a token: - $ carbide-admin-cli credential add-ufm --url https://192.0.2.10 --token mypassword + $ nico-admin-cli credential add-ufm --url https://192.0.2.10 --token mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/bgp/set_sitewide/args.rs b/crates/admin-cli/src/credential/bgp/set_sitewide/args.rs index 8634b1f931..e741a835d8 100644 --- a/crates/admin-cli/src/credential/bgp/set_sitewide/args.rs +++ b/crates/admin-cli/src/credential/bgp/set_sitewide/args.rs @@ -26,7 +26,7 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Set the site-wide leaf BGP session password: - $ carbide-admin-cli credential bgp set-sitewide --password mynewpassword + $ nico-admin-cli credential bgp set-sitewide --password mynewpassword ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/delete_bmc/args.rs b/crates/admin-cli/src/credential/delete_bmc/args.rs index 7cd7318634..9b6b63bb8a 100644 --- a/crates/admin-cli/src/credential/delete_bmc/args.rs +++ b/crates/admin-cli/src/credential/delete_bmc/args.rs @@ -26,10 +26,10 @@ use crate::credential::common::BmcCredentialType; EXAMPLES: Delete the site-wide BMC root credential: - $ carbide-admin-cli credential delete-bmc --kind=site-wide-root + $ nico-admin-cli credential delete-bmc --kind=site-wide-root Delete a per-BMC root credential for a specific MAC address: - $ carbide-admin-cli credential delete-bmc --kind=bmc-root --mac-address 00:11:22:33:44:55 + $ nico-admin-cli credential delete-bmc --kind=bmc-root --mac-address 00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/delete_nmxm/args.rs b/crates/admin-cli/src/credential/delete_nmxm/args.rs index 66b1cd88c7..81f67f30c7 100644 --- a/crates/admin-cli/src/credential/delete_nmxm/args.rs +++ b/crates/admin-cli/src/credential/delete_nmxm/args.rs @@ -23,7 +23,7 @@ use rpc::{CredentialType, forge as forgerpc}; EXAMPLES: Delete an NMX-M credential by username: - $ carbide-admin-cli credential delete-nmx-m --username admin + $ nico-admin-cli credential delete-nmx-m --username admin ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/delete_ufm/args.rs b/crates/admin-cli/src/credential/delete_ufm/args.rs index 044d10cfc3..3597a33247 100644 --- a/crates/admin-cli/src/credential/delete_ufm/args.rs +++ b/crates/admin-cli/src/credential/delete_ufm/args.rs @@ -26,7 +26,7 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Delete a UFM credential by its URL: - $ carbide-admin-cli credential delete-ufm --url https://192.0.2.10 + $ nico-admin-cli credential delete-ufm --url https://192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/credential/generate_ufm_cert/args.rs b/crates/admin-cli/src/credential/generate_ufm_cert/args.rs index 2e60154bdc..001a314ee7 100644 --- a/crates/admin-cli/src/credential/generate_ufm_cert/args.rs +++ b/crates/admin-cli/src/credential/generate_ufm_cert/args.rs @@ -25,10 +25,10 @@ use crate::credential::common::DEFAULT_IB_FABRIC_NAME; EXAMPLES: Generate a UFM cert for the default fabric: - $ carbide-admin-cli credential generate-ufm-cert + $ nico-admin-cli credential generate-ufm-cert Generate a UFM cert for a named fabric: - $ carbide-admin-cli credential generate-ufm-cert --fabric default + $ nico-admin-cli credential generate-ufm-cert --fabric default ")] pub struct Args { diff --git a/crates/admin-cli/src/devenv/config/apply/args.rs b/crates/admin-cli/src/devenv/config/apply/args.rs index 72d67f8b86..37cecd2c0e 100644 --- a/crates/admin-cli/src/devenv/config/apply/args.rs +++ b/crates/admin-cli/src/devenv/config/apply/args.rs @@ -22,10 +22,10 @@ use clap::{Parser, ValueEnum}; EXAMPLES: Apply a devenv config using network segments: - $ carbide-admin-cli dev-env config apply ./devenv_config.toml --mode network-segment + $ nico-admin-cli dev-env config apply ./devenv_config.toml --mode network-segment Apply a devenv config using VPC prefixes: - $ carbide-admin-cli dev-env config apply ./devenv_config.toml --mode vpc-prefix + $ nico-admin-cli dev-env config apply ./devenv_config.toml --mode vpc-prefix ")] pub struct Args { diff --git a/crates/admin-cli/src/domain/show/args.rs b/crates/admin-cli/src/domain/show/args.rs index ea11d64626..6a56c182e0 100644 --- a/crates/admin-cli/src/domain/show/args.rs +++ b/crates/admin-cli/src/domain/show/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: List all domains: - $ carbide-admin-cli domain show + $ nico-admin-cli domain show Show one domain by ID: - $ carbide-admin-cli domain show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli domain show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpa/ensure/args.rs b/crates/admin-cli/src/dpa/ensure/args.rs index a3855c3a25..baedb85c04 100644 --- a/crates/admin-cli/src/dpa/ensure/args.rs +++ b/crates/admin-cli/src/dpa/ensure/args.rs @@ -24,11 +24,11 @@ use rpc::forge::DpaInterfaceType; EXAMPLES: Create/ensure a DPA interface for a machine: - $ carbide-admin-cli dpa ensure 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpa ensure 12345678-1234-5678-90ab-cdef01234567 \ 00:11:22:33:44:55 BlueField3 5e:00.0 Create/ensure a DPA interface with a device description: - $ carbide-admin-cli dpa ensure 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpa ensure 12345678-1234-5678-90ab-cdef01234567 \ 00:11:22:33:44:55 BlueField3 5e:00.0 \"NVIDIA BlueField-3 B3140L E-Series FHHL SuperNIC\" ")] diff --git a/crates/admin-cli/src/dpa/show/args.rs b/crates/admin-cli/src/dpa/show/args.rs index ec7cdd84fb..30d5f303ce 100644 --- a/crates/admin-cli/src/dpa/show/args.rs +++ b/crates/admin-cli/src/dpa/show/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: List all DPA interfaces: - $ carbide-admin-cli dpa show + $ nico-admin-cli dpa show Show details for one DPA interface: - $ carbide-admin-cli dpa show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpa show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpf/disable/args.rs b/crates/admin-cli/src/dpf/disable/args.rs index 7b334a587f..d8cbab44c3 100644 --- a/crates/admin-cli/src/dpf/disable/args.rs +++ b/crates/admin-cli/src/dpf/disable/args.rs @@ -27,7 +27,7 @@ use crate::dpf::common::DpfQuery; EXAMPLES: Disable DPF for a host machine: - $ carbide-admin-cli dpf disable 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpf disable 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpf/enable/args.rs b/crates/admin-cli/src/dpf/enable/args.rs index 5e666a58bf..6c074bad25 100644 --- a/crates/admin-cli/src/dpf/enable/args.rs +++ b/crates/admin-cli/src/dpf/enable/args.rs @@ -27,7 +27,7 @@ use crate::dpf::common::DpfQuery; EXAMPLES: Enable DPF for a host machine: - $ carbide-admin-cli dpf enable 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpf enable 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpf/service_version/args.rs b/crates/admin-cli/src/dpf/service_version/args.rs index e842b18d86..8211269187 100644 --- a/crates/admin-cli/src/dpf/service_version/args.rs +++ b/crates/admin-cli/src/dpf/service_version/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Compare configured vs deployed DPF service versions: - $ carbide-admin-cli dpf service-version + $ nico-admin-cli dpf service-version Same, using the short alias: - $ carbide-admin-cli dpf sv + $ nico-admin-cli dpf sv ")] pub struct Args {} diff --git a/crates/admin-cli/src/dpf/show/args.rs b/crates/admin-cli/src/dpf/show/args.rs index 6624dc4ac5..62bd80fbf9 100644 --- a/crates/admin-cli/src/dpf/show/args.rs +++ b/crates/admin-cli/src/dpf/show/args.rs @@ -27,10 +27,10 @@ use crate::dpf::common::DpfQuery; EXAMPLES: Show DPF status for all hosts: - $ carbide-admin-cli dpf show + $ nico-admin-cli dpf show Show DPF status for one host machine: - $ carbide-admin-cli dpf show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpf show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpf/snapshot/args.rs b/crates/admin-cli/src/dpf/snapshot/args.rs index be965b35f5..9840831385 100644 --- a/crates/admin-cli/src/dpf/snapshot/args.rs +++ b/crates/admin-cli/src/dpf/snapshot/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Snapshot the DPF CRs for a host machine: - $ carbide-admin-cli dpf snapshot 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpf snapshot 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu/agent_upgrade_policy/args.rs b/crates/admin-cli/src/dpu/agent_upgrade_policy/args.rs index 80e04c165d..6936a29d3b 100644 --- a/crates/admin-cli/src/dpu/agent_upgrade_policy/args.rs +++ b/crates/admin-cli/src/dpu/agent_upgrade_policy/args.rs @@ -23,16 +23,16 @@ use rpc::forge::DpuAgentUpgradePolicyRequest; EXAMPLES: Show the current forge-dpu-agent upgrade policy: - $ carbide-admin-cli dpu agent-upgrade-policy + $ nico-admin-cli dpu agent-upgrade-policy Allow the agent to upgrade only (never downgrade): - $ carbide-admin-cli dpu agent-upgrade-policy --set up-only + $ nico-admin-cli dpu agent-upgrade-policy --set up-only Allow the agent to both upgrade and downgrade: - $ carbide-admin-cli dpu agent-upgrade-policy --set up-down + $ nico-admin-cli dpu agent-upgrade-policy --set up-down Disable automatic agent version changes: - $ carbide-admin-cli dpu agent-upgrade-policy --set off + $ nico-admin-cli dpu agent-upgrade-policy --set off ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu/health_report/args.rs b/crates/admin-cli/src/dpu/health_report/args.rs index f11fbbd374..614763e74a 100644 --- a/crates/admin-cli/src/dpu/health_report/args.rs +++ b/crates/admin-cli/src/dpu/health_report/args.rs @@ -25,14 +25,14 @@ use crate::machine::HealthReportTemplates; EXAMPLES: List the health report sources for a DPU: - $ carbide-admin-cli dpu health-report show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu health-report show 12345678-1234-5678-90ab-cdef01234567 Add a health report source from a predefined template: - $ carbide-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance Remove a health report source from a DPU: - $ carbide-admin-cli dpu health-report remove 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report remove 12345678-1234-5678-90ab-cdef01234567 \ internal-maintenance ")] @@ -42,7 +42,7 @@ pub enum Args { EXAMPLES: List the health report sources for a DPU: - $ carbide-admin-cli dpu health-report show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu health-report show 12345678-1234-5678-90ab-cdef01234567 ")] Show { dpu_id: MachineId }, @@ -55,7 +55,7 @@ List the health report sources for a DPU: EXAMPLES: Remove a health report source from a DPU: - $ carbide-admin-cli dpu health-report remove 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report remove 12345678-1234-5678-90ab-cdef01234567 \ internal-maintenance ")] @@ -71,23 +71,23 @@ Remove a health report source from a DPU: EXAMPLES: Add a health report source from a predefined template: - $ carbide-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance Add a template-based source with a custom message: - $ carbide-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template out-for-repair --message \"awaiting replacement part\" Add a raw JSON health report source: - $ carbide-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ --health-report '{\"status\":\"Degraded\"}' Replace the DPU's health contribution with this source: - $ carbide-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance --replace Preview the report without sending it to carbide: - $ carbide-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance --print-only ")] diff --git a/crates/admin-cli/src/dpu/network/args.rs b/crates/admin-cli/src/dpu/network/args.rs index 83756ed104..4a20062b79 100644 --- a/crates/admin-cli/src/dpu/network/args.rs +++ b/crates/admin-cli/src/dpu/network/args.rs @@ -21,10 +21,10 @@ EXAMPLES: Print network status of all DPUs: - $ carbide-admin-cli dpu network status + $ nico-admin-cli dpu network status Show the VPC network configuration for one DPU: - $ carbide-admin-cli dpu network config --machine-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu network config --machine-id 12345678-1234-5678-90ab-cdef01234567 ")] pub enum Args { @@ -35,7 +35,7 @@ pub enum Args { EXAMPLES: Show the VPC network configuration for one DPU: - $ carbide-admin-cli dpu network config --machine-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu network config --machine-id 12345678-1234-5678-90ab-cdef01234567 ")] Config(crate::machine::NetworkConfigQuery), diff --git a/crates/admin-cli/src/dpu/reprovision/args.rs b/crates/admin-cli/src/dpu/reprovision/args.rs index e197d96f42..081671ae59 100644 --- a/crates/admin-cli/src/dpu/reprovision/args.rs +++ b/crates/admin-cli/src/dpu/reprovision/args.rs @@ -25,16 +25,16 @@ use rpc::forge::{DpuReprovisioningRequest, UpdateInitiator}; EXAMPLES: List all DPUs pending reprovisioning: - $ carbide-admin-cli dpu reprovision list + $ nico-admin-cli dpu reprovision list Set a DPU into reprovisioning mode: - $ carbide-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 Clear reprovisioning mode for a DPU: - $ carbide-admin-cli dpu reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 Restart reprovisioning for a host: - $ carbide-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 ")] pub enum Args { @@ -53,13 +53,13 @@ pub enum Args { EXAMPLES: Set a single DPU into reprovisioning mode: - $ carbide-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 Reprovision all DPUs on a host by passing the host machine id: - $ carbide-admin-cli dpu reprovision set --id abcdef01-2345-6789-abcd-ef0123456789 + $ nico-admin-cli dpu reprovision set --id abcdef01-2345-6789-abcd-ef0123456789 Reprovision and update DPU firmware, recording a maintenance message: - $ carbide-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 \ --update-firmware --update-message \"scheduled firmware refresh\" ")] @@ -99,10 +99,10 @@ impl From<&DpuReprovisionSet> for DpuReprovisioningRequest { EXAMPLES: Clear reprovisioning mode for a single DPU: - $ carbide-admin-cli dpu reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 Clear reprovisioning for all DPUs on a host by passing the host machine id: - $ carbide-admin-cli dpu reprovision clear --id abcdef01-2345-6789-abcd-ef0123456789 + $ nico-admin-cli dpu reprovision clear --id abcdef01-2345-6789-abcd-ef0123456789 ")] pub struct DpuReprovisionClear { @@ -134,10 +134,10 @@ impl From<&DpuReprovisionClear> for DpuReprovisioningRequest { EXAMPLES: Restart reprovisioning for a host: - $ carbide-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 Restart reprovisioning and update DPU firmware: - $ carbide-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 \ --update-firmware ")] diff --git a/crates/admin-cli/src/dpu/versions/args.rs b/crates/admin-cli/src/dpu/versions/args.rs index a18be5d5c4..3c5153dfb8 100644 --- a/crates/admin-cli/src/dpu/versions/args.rs +++ b/crates/admin-cli/src/dpu/versions/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Show firmware versions for all DPUs: - $ carbide-admin-cli dpu versions + $ nico-admin-cli dpu versions Show only DPUs that need a firmware upgrade: - $ carbide-admin-cli dpu versions --updates-only + $ nico-admin-cli dpu versions --updates-only ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu_remediation/approve/args.rs b/crates/admin-cli/src/dpu_remediation/approve/args.rs index 0bbc4a94f6..b83d5391d0 100644 --- a/crates/admin-cli/src/dpu_remediation/approve/args.rs +++ b/crates/admin-cli/src/dpu_remediation/approve/args.rs @@ -24,7 +24,7 @@ use rpc::forge::ApproveRemediationRequest; EXAMPLES: Approve a remediation: - $ carbide-admin-cli dpu-remediation approve --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu-remediation approve --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu_remediation/create/args.rs b/crates/admin-cli/src/dpu_remediation/create/args.rs index 26fbe79b12..2f69c3ee9d 100644 --- a/crates/admin-cli/src/dpu_remediation/create/args.rs +++ b/crates/admin-cli/src/dpu_remediation/create/args.rs @@ -22,13 +22,13 @@ use clap::Parser; EXAMPLES: Create a remediation from a script: - $ carbide-admin-cli dpu-remediation create --script-filename ./remediate.sh + $ nico-admin-cli dpu-remediation create --script-filename ./remediate.sh Create a remediation that retries up to three times: - $ carbide-admin-cli dpu-remediation create --script-filename ./remediate.sh --retries 3 + $ nico-admin-cli dpu-remediation create --script-filename ./remediate.sh --retries 3 Create a remediation with descriptive metadata and a label: - $ carbide-admin-cli dpu-remediation create --script-filename ./remediate.sh \ + $ nico-admin-cli dpu-remediation create --script-filename ./remediate.sh \ --meta-name \"clear-eeprom\" --meta-description \"Clears stale EEPROM state\" --label DATACENTER:XYZ ")] diff --git a/crates/admin-cli/src/dpu_remediation/disable/args.rs b/crates/admin-cli/src/dpu_remediation/disable/args.rs index b91d92b921..413dec5ec3 100644 --- a/crates/admin-cli/src/dpu_remediation/disable/args.rs +++ b/crates/admin-cli/src/dpu_remediation/disable/args.rs @@ -24,7 +24,7 @@ use rpc::forge::DisableRemediationRequest; EXAMPLES: Disable a remediation: - $ carbide-admin-cli dpu-remediation disable --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu-remediation disable --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu_remediation/enable/args.rs b/crates/admin-cli/src/dpu_remediation/enable/args.rs index 2e4cfd6a08..4f987b241b 100644 --- a/crates/admin-cli/src/dpu_remediation/enable/args.rs +++ b/crates/admin-cli/src/dpu_remediation/enable/args.rs @@ -24,7 +24,7 @@ use rpc::forge::EnableRemediationRequest; EXAMPLES: Enable a remediation: - $ carbide-admin-cli dpu-remediation enable --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu-remediation enable --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu_remediation/list_applied/args.rs b/crates/admin-cli/src/dpu_remediation/list_applied/args.rs index 36d8cdce9a..d7567d00b3 100644 --- a/crates/admin-cli/src/dpu_remediation/list_applied/args.rs +++ b/crates/admin-cli/src/dpu_remediation/list_applied/args.rs @@ -24,18 +24,18 @@ use clap::Parser; EXAMPLES: List all applied remediations: - $ carbide-admin-cli dpu-remediation list-applied + $ nico-admin-cli dpu-remediation list-applied List the machines a specific remediation has been applied to: - $ carbide-admin-cli dpu-remediation list-applied \ + $ nico-admin-cli dpu-remediation list-applied \ --remediation-id 12345678-1234-5678-90ab-cdef01234567 List the remediations applied to a specific machine: - $ carbide-admin-cli dpu-remediation list-applied \ + $ nico-admin-cli dpu-remediation list-applied \ --machine-id abcdef01-2345-6789-abcd-ef0123456789 Show full details for one remediation on one machine: - $ carbide-admin-cli dpu-remediation list-applied \ + $ nico-admin-cli dpu-remediation list-applied \ --remediation-id 12345678-1234-5678-90ab-cdef01234567 \ --machine-id abcdef01-2345-6789-abcd-ef0123456789 diff --git a/crates/admin-cli/src/dpu_remediation/revoke/args.rs b/crates/admin-cli/src/dpu_remediation/revoke/args.rs index 92fb5e2e90..4412e76f6d 100644 --- a/crates/admin-cli/src/dpu_remediation/revoke/args.rs +++ b/crates/admin-cli/src/dpu_remediation/revoke/args.rs @@ -24,7 +24,7 @@ use rpc::forge::RevokeRemediationRequest; EXAMPLES: Revoke a remediation: - $ carbide-admin-cli dpu-remediation revoke --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu-remediation revoke --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/dpu_remediation/show/args.rs b/crates/admin-cli/src/dpu_remediation/show/args.rs index 49f87e480b..5cd964ce8f 100644 --- a/crates/admin-cli/src/dpu_remediation/show/args.rs +++ b/crates/admin-cli/src/dpu_remediation/show/args.rs @@ -23,13 +23,13 @@ use clap::Parser; EXAMPLES: List all remediations: - $ carbide-admin-cli dpu-remediation show + $ nico-admin-cli dpu-remediation show Show details for one remediation: - $ carbide-admin-cli dpu-remediation show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli dpu-remediation show 12345678-1234-5678-90ab-cdef01234567 Show a remediation including its script body: - $ carbide-admin-cli dpu-remediation show 12345678-1234-5678-90ab-cdef01234567 --display-script + $ nico-admin-cli dpu-remediation show 12345678-1234-5678-90ab-cdef01234567 --display-script ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_machines/add/args.rs b/crates/admin-cli/src/expected_machines/add/args.rs index 4d635b4970..819c76b6ad 100644 --- a/crates/admin-cli/src/expected_machines/add/args.rs +++ b/crates/admin-cli/src/expected_machines/add/args.rs @@ -26,28 +26,28 @@ use serde::{Deserialize, Serialize}; use crate::errors::{CarbideCliError, CarbideCliResult}; -/// `carbide-admin-cli expected-machine add` — mirrors expected switch flags; optional +/// `nico-admin-cli expected-machine add` — mirrors expected switch flags; optional /// `--bmc-ip-address` forwards to the API static-BMC pre-allocation path. #[derive(Parser, Debug, Serialize, Deserialize)] #[command(after_long_help = "\ EXAMPLES: Add an expected machine with the required identifiers: - $ carbide-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 Add a machine with metadata and a SKU: - $ carbide-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 \ --meta-name MyMachine --label DATACENTER:XYZ --sku-id DGX-H100-640GB Pre-allocate a static BMC IP (site-explorer path, like expected switches): - $ carbide-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 \ --bmc-ip-address 192.0.2.20 Add a host whose DPU should be treated as a plain NIC: - $ carbide-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 \ --dpu-mode nic-mode diff --git a/crates/admin-cli/src/expected_machines/delete/args.rs b/crates/admin-cli/src/expected_machines/delete/args.rs index 87a02843c3..2f68933dbb 100644 --- a/crates/admin-cli/src/expected_machines/delete/args.rs +++ b/crates/admin-cli/src/expected_machines/delete/args.rs @@ -26,10 +26,10 @@ use crate::errors::CarbideCliError; EXAMPLES: Delete an expected machine by BMC MAC address: - $ carbide-admin-cli expected-machine delete 00:11:22:33:44:55 + $ nico-admin-cli expected-machine delete 00:11:22:33:44:55 Delete an expected machine by id: - $ carbide-admin-cli expected-machine delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-machine delete --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_machines/erase/args.rs b/crates/admin-cli/src/expected_machines/erase/args.rs index 7efd176297..d94cbcb416 100644 --- a/crates/admin-cli/src/expected_machines/erase/args.rs +++ b/crates/admin-cli/src/expected_machines/erase/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Erase every expected machine (requires explicit confirmation): - $ carbide-admin-cli expected-machine erase --confirm + $ nico-admin-cli expected-machine erase --confirm ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_machines/mod.rs b/crates/admin-cli/src/expected_machines/mod.rs index 1821ea3681..44a0533009 100644 --- a/crates/admin-cli/src/expected_machines/mod.rs +++ b/crates/admin-cli/src/expected_machines/mod.rs @@ -45,10 +45,10 @@ pub enum Cmd { /// /// Examples: /// # Update only SKU, preserve all other fields including metadata - /// carbide-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f --sku-id new_sku + /// nico-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f --sku-id new_sku /// /// # Update only labels, preserve name and description - /// carbide-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f \ + /// nico-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f \ /// --sku-id sku123 --label env:prod --label team:platform #[clap(verbatim_doc_comment)] Patch(patch::Args), @@ -73,7 +73,7 @@ pub enum Cmd { /// } /// /// Usage: - /// carbide-admin-cli expected-machine update --filename machine.json + /// nico-admin-cli expected-machine update --filename machine.json #[clap(verbatim_doc_comment)] Update(update::Args), /// Replace all entries in the expected machines table with the entries from an inputted json file. diff --git a/crates/admin-cli/src/expected_machines/patch/args.rs b/crates/admin-cli/src/expected_machines/patch/args.rs index 76bf0689bd..2cf8c3da66 100644 --- a/crates/admin-cli/src/expected_machines/patch/args.rs +++ b/crates/admin-cli/src/expected_machines/patch/args.rs @@ -33,10 +33,10 @@ use crate::errors::CarbideCliError; /// /// Examples: /// # Update only SKU, preserve all other fields including metadata -/// carbide-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f --sku-id new_sku +/// nico-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f --sku-id new_sku /// /// # Update only labels, preserve name and description -/// carbide-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f \ +/// nico-admin-cli expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f \ /// --sku-id sku123 --label env:prod --label team:platform #[derive(Parser, Debug, Serialize, Deserialize)] #[clap(verbatim_doc_comment)] @@ -54,19 +54,19 @@ use crate::errors::CarbideCliError; EXAMPLES: Patch only the SKU of a machine, selected by BMC MAC address: - $ carbide-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 \ --sku-id DGX-H100-640GB Patch a machine selected by id: - $ carbide-admin-cli expected-machine patch --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-machine patch --id 12345678-1234-5678-90ab-cdef01234567 \ --sku-id DGX-H100-640GB Rotate the BMC credentials (username and password must be set together): - $ carbide-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mynewpassword Change the per-host DPU mode: - $ carbide-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 \ --dpu-mode no-dpu ")] diff --git a/crates/admin-cli/src/expected_machines/replace_all/args.rs b/crates/admin-cli/src/expected_machines/replace_all/args.rs index 75214f6afc..7ef3133685 100644 --- a/crates/admin-cli/src/expected_machines/replace_all/args.rs +++ b/crates/admin-cli/src/expected_machines/replace_all/args.rs @@ -49,7 +49,7 @@ use clap::Parser; EXAMPLES: Replace the entire expected machines table from a JSON file: - $ carbide-admin-cli expected-machine replace-all --filename ./expected-machines.json + $ nico-admin-cli expected-machine replace-all --filename ./expected-machines.json ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_machines/show/args.rs b/crates/admin-cli/src/expected_machines/show/args.rs index 8bfb97d125..69a6d08437 100644 --- a/crates/admin-cli/src/expected_machines/show/args.rs +++ b/crates/admin-cli/src/expected_machines/show/args.rs @@ -26,13 +26,13 @@ use crate::errors::CarbideCliError; EXAMPLES: List all expected machines: - $ carbide-admin-cli expected-machine show + $ nico-admin-cli expected-machine show Show one expected machine by BMC MAC address: - $ carbide-admin-cli expected-machine show 00:11:22:33:44:55 + $ nico-admin-cli expected-machine show 00:11:22:33:44:55 Show one expected machine by id: - $ carbide-admin-cli expected-machine show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-machine show --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_machines/update/args.rs b/crates/admin-cli/src/expected_machines/update/args.rs index b99dd9ba36..29f8fbcd24 100644 --- a/crates/admin-cli/src/expected_machines/update/args.rs +++ b/crates/admin-cli/src/expected_machines/update/args.rs @@ -38,14 +38,14 @@ use clap::Parser; /// } /// /// Usage: -/// carbide-admin-cli expected-machine update --filename machine.json +/// nico-admin-cli expected-machine update --filename machine.json #[derive(Parser, Debug)] #[clap(verbatim_doc_comment)] #[command(after_long_help = "\ EXAMPLES: Replace an expected machine record from a JSON file: - $ carbide-admin-cli expected-machine update --filename ./machine.json + $ nico-admin-cli expected-machine update --filename ./machine.json ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_power_shelf/add/args.rs b/crates/admin-cli/src/expected_power_shelf/add/args.rs index 45f3eb3746..48b6977304 100644 --- a/crates/admin-cli/src/expected_power_shelf/add/args.rs +++ b/crates/admin-cli/src/expected_power_shelf/add/args.rs @@ -29,16 +29,16 @@ use crate::metadata::parse_rpc_labels; EXAMPLES: Add an expected power shelf with its BMC credentials and serial number: - $ carbide-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --shelf-serial-number DGX-H100-640GB Add an expected power shelf and associate it with a rack: - $ carbide-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --shelf-serial-number DGX-H100-640GB \ --rack_id 12345678-1234-5678-90ab-cdef01234567 Add an expected power shelf with a BMC IP address and metadata name: - $ carbide-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --shelf-serial-number DGX-H100-640GB \ --bmc-ip-address 192.0.2.20 --meta-name shelf-01 diff --git a/crates/admin-cli/src/expected_power_shelf/delete/args.rs b/crates/admin-cli/src/expected_power_shelf/delete/args.rs index 2b1c1138be..bbd8a45f93 100644 --- a/crates/admin-cli/src/expected_power_shelf/delete/args.rs +++ b/crates/admin-cli/src/expected_power_shelf/delete/args.rs @@ -26,10 +26,10 @@ use crate::errors::CarbideCliError; EXAMPLES: Delete an expected power shelf by BMC MAC address: - $ carbide-admin-cli expected-power-shelf delete 00:11:22:33:44:55 + $ nico-admin-cli expected-power-shelf delete 00:11:22:33:44:55 Delete an expected power shelf by ID: - $ carbide-admin-cli expected-power-shelf delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-power-shelf delete --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_power_shelf/erase/args.rs b/crates/admin-cli/src/expected_power_shelf/erase/args.rs index 450a600646..8489b0c595 100644 --- a/crates/admin-cli/src/expected_power_shelf/erase/args.rs +++ b/crates/admin-cli/src/expected_power_shelf/erase/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Erase all expected power shelf records (requires explicit confirmation): - $ carbide-admin-cli expected-power-shelf erase --confirm + $ nico-admin-cli expected-power-shelf erase --confirm ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_power_shelf/replace_all/args.rs b/crates/admin-cli/src/expected_power_shelf/replace_all/args.rs index b762b2bd9c..1a84539f99 100644 --- a/crates/admin-cli/src/expected_power_shelf/replace_all/args.rs +++ b/crates/admin-cli/src/expected_power_shelf/replace_all/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Replace all expected power shelves with the contents of a JSON file: - $ carbide-admin-cli expected-power-shelf replace-all --filename ./power-shelves.json + $ nico-admin-cli expected-power-shelf replace-all --filename ./power-shelves.json ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_power_shelf/show/args.rs b/crates/admin-cli/src/expected_power_shelf/show/args.rs index 1006a238af..135fb017e8 100644 --- a/crates/admin-cli/src/expected_power_shelf/show/args.rs +++ b/crates/admin-cli/src/expected_power_shelf/show/args.rs @@ -26,13 +26,13 @@ use crate::errors::CarbideCliError; EXAMPLES: List all expected power shelves: - $ carbide-admin-cli expected-power-shelf show + $ nico-admin-cli expected-power-shelf show Show one expected power shelf by BMC MAC address: - $ carbide-admin-cli expected-power-shelf show 00:11:22:33:44:55 + $ nico-admin-cli expected-power-shelf show 00:11:22:33:44:55 Show one expected power shelf by ID: - $ carbide-admin-cli expected-power-shelf show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-power-shelf show --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_power_shelf/update/args.rs b/crates/admin-cli/src/expected_power_shelf/update/args.rs index a2bd1ea776..808056a1ee 100644 --- a/crates/admin-cli/src/expected_power_shelf/update/args.rs +++ b/crates/admin-cli/src/expected_power_shelf/update/args.rs @@ -30,11 +30,11 @@ use crate::errors::CarbideCliError; EXAMPLES: Update an expected power shelf's BMC credentials, selecting it by MAC address: - $ carbide-admin-cli expected-power-shelf update --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-power-shelf update --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mynewpassword Update an expected power shelf's serial number, selecting it by ID: - $ carbide-admin-cli expected-power-shelf update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-power-shelf update --id 12345678-1234-5678-90ab-cdef01234567 \ --shelf-serial-number DGX-H100-640GB ")] diff --git a/crates/admin-cli/src/expected_rack/add/args.rs b/crates/admin-cli/src/expected_rack/add/args.rs index e0b6b21f61..85d31bfbbb 100644 --- a/crates/admin-cli/src/expected_rack/add/args.rs +++ b/crates/admin-cli/src/expected_rack/add/args.rs @@ -26,11 +26,11 @@ use crate::metadata::parse_rpc_labels; EXAMPLES: Add an expected rack with its rack profile: - $ carbide-admin-cli expected-rack add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-rack add 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 Add an expected rack with a metadata name and a label: - $ carbide-admin-cli expected-rack add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-rack add 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 --meta-name rack-01 --label DATACENTER:XYZ ")] diff --git a/crates/admin-cli/src/expected_rack/delete/args.rs b/crates/admin-cli/src/expected_rack/delete/args.rs index f6c9128f95..03e769cc58 100644 --- a/crates/admin-cli/src/expected_rack/delete/args.rs +++ b/crates/admin-cli/src/expected_rack/delete/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Delete an expected rack by rack ID: - $ carbide-admin-cli expected-rack delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-rack delete 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_rack/erase/args.rs b/crates/admin-cli/src/expected_rack/erase/args.rs index ec06d45261..4dcc050d05 100644 --- a/crates/admin-cli/src/expected_rack/erase/args.rs +++ b/crates/admin-cli/src/expected_rack/erase/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Erase all expected rack records (requires explicit confirmation): - $ carbide-admin-cli expected-rack erase --confirm + $ nico-admin-cli expected-rack erase --confirm ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_rack/replace_all/args.rs b/crates/admin-cli/src/expected_rack/replace_all/args.rs index abf76cf8ba..99ede3988e 100644 --- a/crates/admin-cli/src/expected_rack/replace_all/args.rs +++ b/crates/admin-cli/src/expected_rack/replace_all/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Replace all expected racks with the contents of a JSON file: - $ carbide-admin-cli expected-rack replace-all --filename ./racks.json + $ nico-admin-cli expected-rack replace-all --filename ./racks.json ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_rack/show/args.rs b/crates/admin-cli/src/expected_rack/show/args.rs index 2e5a112516..0cdba55d89 100644 --- a/crates/admin-cli/src/expected_rack/show/args.rs +++ b/crates/admin-cli/src/expected_rack/show/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: List all expected racks: - $ carbide-admin-cli expected-rack show + $ nico-admin-cli expected-rack show Show one expected rack by rack ID: - $ carbide-admin-cli expected-rack show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-rack show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_rack/update/args.rs b/crates/admin-cli/src/expected_rack/update/args.rs index 39d5b45bfe..c6ff4eb995 100644 --- a/crates/admin-cli/src/expected_rack/update/args.rs +++ b/crates/admin-cli/src/expected_rack/update/args.rs @@ -26,11 +26,11 @@ use crate::errors::CarbideCliError; EXAMPLES: Update an expected rack's rack profile: - $ carbide-admin-cli expected-rack update 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-rack update 12345678-1234-5678-90ab-cdef01234567 \ --rack-profile-id abcdef01-2345-6789-abcd-ef0123456789 Update an expected rack's metadata name: - $ carbide-admin-cli expected-rack update 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-rack update 12345678-1234-5678-90ab-cdef01234567 \ --rack-profile-id abcdef01-2345-6789-abcd-ef0123456789 --meta-name rack-01 ")] diff --git a/crates/admin-cli/src/expected_switch/add/args.rs b/crates/admin-cli/src/expected_switch/add/args.rs index 2a7becdde0..6bfa94d9cb 100644 --- a/crates/admin-cli/src/expected_switch/add/args.rs +++ b/crates/admin-cli/src/expected_switch/add/args.rs @@ -29,22 +29,22 @@ use crate::metadata::parse_rpc_labels; EXAMPLES: Add an expected switch with its BMC credentials and serial number: - $ carbide-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB Add an expected switch and associate it with a rack: - $ carbide-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB \ --rack_id 12345678-1234-5678-90ab-cdef01234567 Add an expected switch with NVOS credentials and a static NVOS IP: - $ carbide-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB \ --nvos-mac-address aa:bb:cc:dd:ee:ff --nvos-username admin --nvos-password mypassword \ --nvos-ip-address 192.0.2.10 Add an expected switch with metadata name and a label: - $ carbide-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB \ --meta-name spine-01 --label DATACENTER:XYZ diff --git a/crates/admin-cli/src/expected_switch/delete/args.rs b/crates/admin-cli/src/expected_switch/delete/args.rs index 49d14c4461..44c552f060 100644 --- a/crates/admin-cli/src/expected_switch/delete/args.rs +++ b/crates/admin-cli/src/expected_switch/delete/args.rs @@ -26,10 +26,10 @@ use crate::errors::CarbideCliError; EXAMPLES: Delete an expected switch by BMC MAC address: - $ carbide-admin-cli expected-switch delete 00:11:22:33:44:55 + $ nico-admin-cli expected-switch delete 00:11:22:33:44:55 Delete an expected switch by ID: - $ carbide-admin-cli expected-switch delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-switch delete --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_switch/erase/args.rs b/crates/admin-cli/src/expected_switch/erase/args.rs index d79afeeb9b..56c3f4833b 100644 --- a/crates/admin-cli/src/expected_switch/erase/args.rs +++ b/crates/admin-cli/src/expected_switch/erase/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Erase all expected switch records (requires explicit confirmation): - $ carbide-admin-cli expected-switch erase --confirm + $ nico-admin-cli expected-switch erase --confirm ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_switch/replace_all/args.rs b/crates/admin-cli/src/expected_switch/replace_all/args.rs index 9bb361cf82..fba39c981a 100644 --- a/crates/admin-cli/src/expected_switch/replace_all/args.rs +++ b/crates/admin-cli/src/expected_switch/replace_all/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Replace all expected switches with the contents of a JSON file: - $ carbide-admin-cli expected-switch replace-all --filename ./switches.json + $ nico-admin-cli expected-switch replace-all --filename ./switches.json ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_switch/show/args.rs b/crates/admin-cli/src/expected_switch/show/args.rs index ee6cd3d08c..824790fb22 100644 --- a/crates/admin-cli/src/expected_switch/show/args.rs +++ b/crates/admin-cli/src/expected_switch/show/args.rs @@ -26,13 +26,13 @@ use crate::errors::CarbideCliError; EXAMPLES: List all expected switches: - $ carbide-admin-cli expected-switch show + $ nico-admin-cli expected-switch show Show one expected switch by BMC MAC address: - $ carbide-admin-cli expected-switch show 00:11:22:33:44:55 + $ nico-admin-cli expected-switch show 00:11:22:33:44:55 Show one expected switch by ID: - $ carbide-admin-cli expected-switch show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli expected-switch show --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/expected_switch/update/args.rs b/crates/admin-cli/src/expected_switch/update/args.rs index 2a66242d48..67b02ad57c 100644 --- a/crates/admin-cli/src/expected_switch/update/args.rs +++ b/crates/admin-cli/src/expected_switch/update/args.rs @@ -30,15 +30,15 @@ use crate::errors::CarbideCliError; EXAMPLES: Update an expected switch's BMC credentials, selecting it by MAC address: - $ carbide-admin-cli expected-switch update --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-switch update --bmc-mac-address 00:11:22:33:44:55 \ --bmc-username admin --bmc-password mynewpassword Update an expected switch's serial number, selecting it by ID: - $ carbide-admin-cli expected-switch update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli expected-switch update --id 12345678-1234-5678-90ab-cdef01234567 \ --switch-serial-number DGX-H100-640GB Update an expected switch's NVOS credentials: - $ carbide-admin-cli expected-switch update --bmc-mac-address 00:11:22:33:44:55 \ + $ nico-admin-cli expected-switch update --bmc-mac-address 00:11:22:33:44:55 \ --nvos-username admin --nvos-password mynewpassword ")] diff --git a/crates/admin-cli/src/extension_service/create/args.rs b/crates/admin-cli/src/extension_service/create/args.rs index cef176264b..3c450420e8 100644 --- a/crates/admin-cli/src/extension_service/create/args.rs +++ b/crates/admin-cli/src/extension_service/create/args.rs @@ -26,20 +26,20 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Create a Kubernetes-pod extension service: - $ carbide-admin-cli extension-service create --name my-service --type kubernetes-pod \ + $ nico-admin-cli extension-service create --name my-service --type kubernetes-pod \ --data '{\"image\":\"my-registry/my-service:1.0\"}' Create with an explicit service ID and a description: - $ carbide-admin-cli extension-service create --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service create --id 12345678-1234-5678-90ab-cdef01234567 \ --name my-service --type kubernetes-pod --data '{\"image\":\"my-registry/my-service:1.0\"}' \ --description \"Front-end telemetry agent\" Create scoped to a tenant organization: - $ carbide-admin-cli extension-service create --name my-service --type kubernetes-pod \ + $ nico-admin-cli extension-service create --name my-service --type kubernetes-pod \ --data '{\"image\":\"my-registry/my-service:1.0\"}' --tenant-organization-id fds34511233a Create with private-registry pull credentials: - $ carbide-admin-cli extension-service create --name my-service --type kubernetes-pod \ + $ nico-admin-cli extension-service create --name my-service --type kubernetes-pod \ --data '{\"image\":\"my-registry/my-service:1.0\"}' --registry-url my-registry.example.com \ --username admin --password mypassword diff --git a/crates/admin-cli/src/extension_service/delete/args.rs b/crates/admin-cli/src/extension_service/delete/args.rs index b7859c99ae..474909713d 100644 --- a/crates/admin-cli/src/extension_service/delete/args.rs +++ b/crates/admin-cli/src/extension_service/delete/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Delete an entire extension service (all versions): - $ carbide-admin-cli extension-service delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli extension-service delete --id 12345678-1234-5678-90ab-cdef01234567 Delete only specific versions, keeping the rest: - $ carbide-admin-cli extension-service delete --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service delete --id 12345678-1234-5678-90ab-cdef01234567 \ --versions 1.0,1.1 ")] diff --git a/crates/admin-cli/src/extension_service/get_version/args.rs b/crates/admin-cli/src/extension_service/get_version/args.rs index f06393a987..ad94be3010 100644 --- a/crates/admin-cli/src/extension_service/get_version/args.rs +++ b/crates/admin-cli/src/extension_service/get_version/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Get version info for all versions of a service: - $ carbide-admin-cli extension-service get-version --service-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli extension-service get-version --service-id 12345678-1234-5678-90ab-cdef01234567 Get version info for specific versions: - $ carbide-admin-cli extension-service get-version --service-id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service get-version --service-id 12345678-1234-5678-90ab-cdef01234567 \ --versions 1.0,1.1 ")] diff --git a/crates/admin-cli/src/extension_service/show/args.rs b/crates/admin-cli/src/extension_service/show/args.rs index b7ee61862a..6df6776867 100644 --- a/crates/admin-cli/src/extension_service/show/args.rs +++ b/crates/admin-cli/src/extension_service/show/args.rs @@ -24,19 +24,19 @@ use super::super::common::ExtensionServiceType; EXAMPLES: Show all extension services: - $ carbide-admin-cli extension-service show + $ nico-admin-cli extension-service show Show one extension service by ID: - $ carbide-admin-cli extension-service show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli extension-service show --id 12345678-1234-5678-90ab-cdef01234567 Filter by service type: - $ carbide-admin-cli extension-service show --type kubernetes-pod + $ nico-admin-cli extension-service show --type kubernetes-pod Filter by service name: - $ carbide-admin-cli extension-service show --name my-service + $ nico-admin-cli extension-service show --name my-service Filter by tenant organization ID: - $ carbide-admin-cli extension-service show --tenant-organization-id fds34511233a + $ nico-admin-cli extension-service show --tenant-organization-id fds34511233a ")] pub struct Args { diff --git a/crates/admin-cli/src/extension_service/show_instances/args.rs b/crates/admin-cli/src/extension_service/show_instances/args.rs index 0f4e6d6699..d96884da2e 100644 --- a/crates/admin-cli/src/extension_service/show_instances/args.rs +++ b/crates/admin-cli/src/extension_service/show_instances/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Show all instances using an extension service: - $ carbide-admin-cli extension-service show-instances --service-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli extension-service show-instances --service-id 12345678-1234-5678-90ab-cdef01234567 Show instances using a specific version of the service: - $ carbide-admin-cli extension-service show-instances --service-id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service show-instances --service-id 12345678-1234-5678-90ab-cdef01234567 \ --version 1.0 ")] diff --git a/crates/admin-cli/src/extension_service/update/args.rs b/crates/admin-cli/src/extension_service/update/args.rs index 3337b33f9e..13e6a8ced2 100644 --- a/crates/admin-cli/src/extension_service/update/args.rs +++ b/crates/admin-cli/src/extension_service/update/args.rs @@ -25,21 +25,21 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Update the data of an existing service: - $ carbide-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ --data '{\"image\":\"my-registry/my-service:2.0\"}' Rename a service and update its description: - $ carbide-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ --name my-renamed-service --description \"Updated telemetry agent\" \ --data '{\"image\":\"my-registry/my-service:2.0\"}' Rotate the registry pull credentials: - $ carbide-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ --data '{\"image\":\"my-registry/my-service:2.0\"}' --registry-url my-registry.example.com \ --username admin --password mynewpassword Update only if the version counter matches (optimistic concurrency): - $ carbide-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 \ --data '{\"image\":\"my-registry/my-service:2.0\"}' --if-version-ctr-match 3 ")] diff --git a/crates/admin-cli/src/firmware/show/args.rs b/crates/admin-cli/src/firmware/show/args.rs index 7f924bb799..15963d2174 100644 --- a/crates/admin-cli/src/firmware/show/args.rs +++ b/crates/admin-cli/src/firmware/show/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Show all available firmware: - $ carbide-admin-cli firmware show + $ nico-admin-cli firmware show ")] pub struct Args {} diff --git a/crates/admin-cli/src/generate_docs/args.rs b/crates/admin-cli/src/generate_docs/args.rs index 1a67eb7573..a21aa7df10 100644 --- a/crates/admin-cli/src/generate_docs/args.rs +++ b/crates/admin-cli/src/generate_docs/args.rs @@ -23,11 +23,11 @@ use clap::Parser; #[command(after_long_help = "\ EXAMPLES: -Regenerate the CLI reference in place (the default docs/cli): - $ carbide-admin-cli generate-cli-docs +Regenerate the CLI reference in place (the default docs/manuals/nico-admin-cli): + $ nico-admin-cli generate-cli-docs Write the generated pages to a different directory: - $ carbide-admin-cli generate-cli-docs --out-dir /tmp/cli-docs + $ nico-admin-cli generate-cli-docs --out-dir /tmp/cli-docs ")] pub struct Cmd { @@ -36,6 +36,6 @@ pub struct Cmd { /// command, plus the four domain index pages /// (`hardware.md`/`network.md`/`tenant.md`/`admin.md`). Hand-authored /// pages (`README.md`, `workflows.md`, `setup.md`, …) are left untouched. - #[clap(long, default_value = "docs/cli")] + #[clap(long, default_value = "docs/manuals/nico-admin-cli")] pub out_dir: PathBuf, } diff --git a/crates/admin-cli/src/generate_docs/cmds.rs b/crates/admin-cli/src/generate_docs/cmds.rs index d1d5f4e00b..6f3d4b0c78 100644 --- a/crates/admin-cli/src/generate_docs/cmds.rs +++ b/crates/admin-cli/src/generate_docs/cmds.rs @@ -15,7 +15,7 @@ * limitations under the License. */ -//! Generates the `docs/cli` markdown reference from the live clap command tree. +//! Generates the `docs/manuals/nico-admin-cli` markdown reference from the live clap command tree. //! //! The per-command pages are derived from the same man pages the //! `generate-man` subcommand produces: we render every command's roff man page @@ -40,7 +40,7 @@ use clap::{Command, CommandFactory}; use crate::cfg::cli_options::{CliDomain, CliOptions, domain_for_command}; use crate::errors::{CarbideCliError, CarbideCliResult}; -const BIN: &str = "carbide-admin-cli"; +const BIN: &str = "nico-admin-cli"; const DOMAINS: [CliDomain; 4] = [ CliDomain::Hardware, CliDomain::Network, @@ -53,8 +53,8 @@ pub fn generate(out_dir: &Path) -> CarbideCliResult<()> { // Render every command's roff man page into a scratch directory. clap_mangen // names each file by the full command path joined with '-' (e.g. - // `carbide-admin-cli-vpc-show.1`), which we reconstruct per node below. - let man_dir = std::env::temp_dir().join("carbide-admin-cli-cli-docs-man"); + // `nico-admin-cli-vpc-show.1`), which we reconstruct per node below. + let man_dir = std::env::temp_dir().join("nico-admin-cli-cli-docs-man"); let _ = std::fs::remove_dir_all(&man_dir); std::fs::create_dir_all(&man_dir)?; clap_mangen::generate_to(root.clone(), &man_dir)?; @@ -112,7 +112,7 @@ pub fn generate(out_dir: &Path) -> CarbideCliResult<()> { } /// Writes the markdown page for `cmd` (whose full path from the binary is -/// `path`, e.g. `["carbide-admin-cli", "vpc", "show"]`) and recurses into its +/// `path`, e.g. `["nico-admin-cli", "vpc", "show"]`) and recurses into its /// visible subcommands. Every page for one top-level command lives flat in /// `dir`, named by the path below the binary joined with '-' (so `vpc show` /// becomes `vpc-show.md`). @@ -221,7 +221,7 @@ fn render_domain_index(domain: CliDomain, rows: &[&(String, String, CliDomain)]) // ---- helpers ---- /// The page stem for a command path: the path below the binary joined with '-' -/// (`["carbide-admin-cli", "vpc", "show"]` -> `"vpc-show"`). Both the file name +/// (`["nico-admin-cli", "vpc", "show"]` -> `"vpc-show"`). Both the file name /// and the in-directory links use this. fn stem(path: &[String]) -> String { path[1..].join("-") diff --git a/crates/admin-cli/src/generate_man/args.rs b/crates/admin-cli/src/generate_man/args.rs index 792e40e5fe..097a6d8940 100644 --- a/crates/admin-cli/src/generate_man/args.rs +++ b/crates/admin-cli/src/generate_man/args.rs @@ -24,10 +24,10 @@ use clap::Parser; EXAMPLES: Generate man pages into the default ./man directory: - $ carbide-admin-cli generate-man + $ nico-admin-cli generate-man Generate man pages into a specific directory: - $ carbide-admin-cli generate-man --out-dir /usr/local/share/man/man1 + $ nico-admin-cli generate-man --out-dir /usr/local/share/man/man1 ")] pub struct Cmd { diff --git a/crates/admin-cli/src/generate_man/cmds.rs b/crates/admin-cli/src/generate_man/cmds.rs index 593833c2b4..a7bc84a5ca 100644 --- a/crates/admin-cli/src/generate_man/cmds.rs +++ b/crates/admin-cli/src/generate_man/cmds.rs @@ -24,7 +24,7 @@ use crate::errors::CarbideCliResult; pub fn generate(out_dir: &Path) -> CarbideCliResult<()> { std::fs::create_dir_all(out_dir)?; - let cmd = CliOptions::command().name("carbide-admin-cli"); + let cmd = CliOptions::command().name("nico-admin-cli"); clap_mangen::generate_to(cmd, out_dir)?; Ok(()) } diff --git a/crates/admin-cli/src/generate_shell_complete/args.rs b/crates/admin-cli/src/generate_shell_complete/args.rs index 20b78a1183..01e72deee5 100644 --- a/crates/admin-cli/src/generate_shell_complete/args.rs +++ b/crates/admin-cli/src/generate_shell_complete/args.rs @@ -21,14 +21,18 @@ use clap::Parser; #[command(after_long_help = "\ EXAMPLES: -Load bash completions into the current shell: - $ source <(carbide-admin-cli generate-shell-complete bash) +Load bash completions into the current shell (also enables carbide-admin-cli and forge-admin-cli): + $ source <(nico-admin-cli generate-shell-complete bash) -Write zsh completions to a file on the fpath: - $ carbide-admin-cli generate-shell-complete zsh > ~/.zfunc/_carbide-admin-cli +Load zsh completions into the current shell (also enables carbide-admin-cli and forge-admin-cli): + $ source <(nico-admin-cli generate-shell-complete zsh) -Generate fish completions: - $ carbide-admin-cli generate-shell-complete fish +Write zsh completions to a file on the fpath (run once; re-source your shell): + $ nico-admin-cli generate-shell-complete zsh > ~/.zfunc/_nico-admin-cli && \ + echo 'compdef _nico-admin-cli carbide-admin-cli forge-admin-cli' >> ~/.zshrc + +Write fish completions to the fish completions directory: + $ nico-admin-cli generate-shell-complete fish > ~/.config/fish/completions/nico-admin-cli.fish ")] pub struct Cmd { diff --git a/crates/admin-cli/src/generate_shell_complete/cmds.rs b/crates/admin-cli/src/generate_shell_complete/cmds.rs index 5d1a44cec7..f0894ca23e 100644 --- a/crates/admin-cli/src/generate_shell_complete/cmds.rs +++ b/crates/admin-cli/src/generate_shell_complete/cmds.rs @@ -31,29 +31,39 @@ pub fn generate(shell: Shell) -> CarbideCliResult<()> { clap_complete::generate( clap_complete::shells::Bash, &mut cmd, - "carbide-admin-cli", + "nico-admin-cli", &mut io::stdout(), ); - // Make completion work for alias `fa` + // Register completions for the short alias and backward-compat symlinks. io::stdout().write_all( - b"complete -F _carbide-admin-cli -o nosort -o bashdefault -o default fa\n", + b"complete -F _nico-admin-cli -o nosort -o bashdefault -o default fa\n\ + complete -F _nico-admin-cli -o nosort -o bashdefault -o default carbide-admin-cli\n\ + complete -F _nico-admin-cli -o nosort -o bashdefault -o default forge-admin-cli\n", )?; } Shell::Fish => { clap_complete::generate( clap_complete::shells::Fish, &mut cmd, - "carbide-admin-cli", + "nico-admin-cli", &mut io::stdout(), ); + // Register completions for backward-compat symlinks by wrapping the canonical command. + io::stdout().write_all( + b"complete -c carbide-admin-cli --wraps nico-admin-cli\n\ + complete -c forge-admin-cli --wraps nico-admin-cli\n", + )?; } Shell::Zsh => { clap_complete::generate( clap_complete::shells::Zsh, &mut cmd, - "carbide-admin-cli", + "nico-admin-cli", &mut io::stdout(), ); + // Register completions for backward-compat symlinks using the same function. + io::stdout() + .write_all(b"compdef _nico-admin-cli carbide-admin-cli forge-admin-cli\n")?; } } Ok(()) diff --git a/crates/admin-cli/src/host/clear_uefi_password/args.rs b/crates/admin-cli/src/host/clear_uefi_password/args.rs index 7a373dd442..c8902c0f7b 100644 --- a/crates/admin-cli/src/host/clear_uefi_password/args.rs +++ b/crates/admin-cli/src/host/clear_uefi_password/args.rs @@ -28,10 +28,10 @@ use crate::machine::MachineQuery; EXAMPLES: Clear the UEFI password for a host by machine ID: - $ carbide-admin-cli host clear-uefi-password --query 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli host clear-uefi-password --query 12345678-1234-5678-90ab-cdef01234567 Clear the UEFI password for a host selected by MAC address: - $ carbide-admin-cli host clear-uefi-password --query 00:11:22:33:44:55 + $ nico-admin-cli host clear-uefi-password --query 00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/host/generate_host_uefi_password/args.rs b/crates/admin-cli/src/host/generate_host_uefi_password/args.rs index 8a33e66772..12130b4617 100644 --- a/crates/admin-cli/src/host/generate_host_uefi_password/args.rs +++ b/crates/admin-cli/src/host/generate_host_uefi_password/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Generate a site-default host UEFI password to store in Vault: - $ carbide-admin-cli host generate-host-uefi-password + $ nico-admin-cli host generate-host-uefi-password ")] pub struct Args {} diff --git a/crates/admin-cli/src/host/reprovision/args.rs b/crates/admin-cli/src/host/reprovision/args.rs index fe215c088d..e4617a9ac5 100644 --- a/crates/admin-cli/src/host/reprovision/args.rs +++ b/crates/admin-cli/src/host/reprovision/args.rs @@ -25,13 +25,13 @@ use clap::Parser; EXAMPLES: Set a host into reprovisioning mode: - $ carbide-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 Clear reprovisioning mode for a host: - $ carbide-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 List all hosts pending reprovisioning: - $ carbide-admin-cli host reprovision list + $ nico-admin-cli host reprovision list ")] pub enum Args { @@ -51,14 +51,14 @@ pub enum Args { EXAMPLES: Set a host into reprovisioning mode: - $ carbide-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 Set into reprovisioning mode and update firmware: - $ carbide-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 \ --update-firmware Set into reprovisioning mode and raise a health alert with a message: - $ carbide-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 \ --update-message \"Quarterly firmware refresh\" ")] @@ -92,10 +92,10 @@ impl From<&ReprovisionSet> for HostReprovisioningRequest { EXAMPLES: Clear reprovisioning mode for a host: - $ carbide-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 Clear reprovisioning mode and update firmware: - $ carbide-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 \ --update-firmware ")] @@ -126,7 +126,7 @@ impl From for HostReprovisioningRequest { EXAMPLES: Mark manual firmware upgrade complete for a host: - $ carbide-admin-cli host reprovision mark-manual-upgrade-complete \ + $ nico-admin-cli host reprovision mark-manual-upgrade-complete \ --id 12345678-1234-5678-90ab-cdef01234567 ")] diff --git a/crates/admin-cli/src/host/set_uefi_password/args.rs b/crates/admin-cli/src/host/set_uefi_password/args.rs index cb41772b13..60b6a7d1c4 100644 --- a/crates/admin-cli/src/host/set_uefi_password/args.rs +++ b/crates/admin-cli/src/host/set_uefi_password/args.rs @@ -28,10 +28,10 @@ use crate::machine::MachineQuery; EXAMPLES: Set the UEFI password for a host by machine ID: - $ carbide-admin-cli host set-uefi-password --query 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli host set-uefi-password --query 12345678-1234-5678-90ab-cdef01234567 Set the UEFI password for a host selected by MAC address: - $ carbide-admin-cli host set-uefi-password --query 00:11:22:33:44:55 + $ nico-admin-cli host set-uefi-password --query 00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/ib_partition/show/args.rs b/crates/admin-cli/src/ib_partition/show/args.rs index 79560ec369..1f35fed5a6 100644 --- a/crates/admin-cli/src/ib_partition/show/args.rs +++ b/crates/admin-cli/src/ib_partition/show/args.rs @@ -23,16 +23,16 @@ use clap::Parser; EXAMPLES: List all InfiniBand partitions: - $ carbide-admin-cli ib-partition show + $ nico-admin-cli ib-partition show Show one InfiniBand partition by ID: - $ carbide-admin-cli ib-partition show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli ib-partition show 12345678-1234-5678-90ab-cdef01234567 List partitions for one tenant: - $ carbide-admin-cli ib-partition show --tenant-org-id fds34511233a + $ nico-admin-cli ib-partition show --tenant-org-id fds34511233a Find a partition by name: - $ carbide-admin-cli ib-partition show --name my-partition + $ nico-admin-cli ib-partition show --name my-partition ")] pub struct Args { diff --git a/crates/admin-cli/src/instance/allocate/args.rs b/crates/admin-cli/src/instance/allocate/args.rs index d8ddc42d0a..c78bdf10f5 100644 --- a/crates/admin-cli/src/instance/allocate/args.rs +++ b/crates/admin-cli/src/instance/allocate/args.rs @@ -26,27 +26,27 @@ use rpc::forge::{InstanceOperatingSystemConfig, InstanceSpxConfig}; EXAMPLES: Allocate one instance onto a VPC prefix: - $ carbide-admin-cli instance allocate --prefix-name eth0 \ + $ nico-admin-cli instance allocate --prefix-name eth0 \ --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 Allocate one instance onto a subnet: - $ carbide-admin-cli instance allocate --prefix-name eth0 --subnet 192.0.2.0/24 + $ nico-admin-cli instance allocate --prefix-name eth0 --subnet 192.0.2.0/24 Allocate several instances at once: - $ carbide-admin-cli instance allocate --number 4 --prefix-name eth0 \ + $ nico-admin-cli instance allocate --number 4 --prefix-name eth0 \ --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 Allocate transactionally (all-or-nothing for --number > 1): - $ carbide-admin-cli instance allocate --number 4 --prefix-name eth0 \ + $ nico-admin-cli instance allocate --number 4 --prefix-name eth0 \ --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 --transactional Allocate onto specific machines: - $ carbide-admin-cli instance allocate --prefix-name eth0 \ + $ nico-admin-cli instance allocate --prefix-name eth0 \ --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 \ --machine-id 12345678-1234-5678-90ab-cdef01234567 Allocate with an expected instance type and a network security group: - $ carbide-admin-cli instance allocate --prefix-name eth0 \ + $ nico-admin-cli instance allocate --prefix-name eth0 \ --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 \ --instance-type-id abcdef01-2345-6789-abcd-ef0123456789 \ --network-security-group-id 12345678-1234-5678-90ab-cdef01234567 diff --git a/crates/admin-cli/src/instance/reboot/args.rs b/crates/admin-cli/src/instance/reboot/args.rs index 5182e5600f..5a7f7f24a2 100644 --- a/crates/admin-cli/src/instance/reboot/args.rs +++ b/crates/admin-cli/src/instance/reboot/args.rs @@ -23,14 +23,14 @@ use clap::Parser; EXAMPLES: Reboot an instance: - $ carbide-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 Reboot and apply any pending firmware updates: - $ carbide-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 \ --apply-updates-on-reboot Reboot into the custom PXE flow: - $ carbide-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 \ --custom-pxe ")] diff --git a/crates/admin-cli/src/instance/release/args.rs b/crates/admin-cli/src/instance/release/args.rs index 59ab864a0b..9ab1ad12f4 100644 --- a/crates/admin-cli/src/instance/release/args.rs +++ b/crates/admin-cli/src/instance/release/args.rs @@ -27,13 +27,13 @@ use clap::{ArgGroup, Parser}; EXAMPLES: Release an instance by id: - $ carbide-admin-cli instance release --instance 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance release --instance 12345678-1234-5678-90ab-cdef01234567 Release the instance on a machine: - $ carbide-admin-cli instance release --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance release --machine 12345678-1234-5678-90ab-cdef01234567 Release every instance matching a label: - $ carbide-admin-cli instance release --label-key role --label-value training + $ nico-admin-cli instance release --label-key role --label-value training ")] pub struct Args { diff --git a/crates/admin-cli/src/instance/show/args.rs b/crates/admin-cli/src/instance/show/args.rs index eb2783d28d..bc17ec2ec8 100644 --- a/crates/admin-cli/src/instance/show/args.rs +++ b/crates/admin-cli/src/instance/show/args.rs @@ -28,22 +28,22 @@ use clap::Parser; EXAMPLES: List all instances: - $ carbide-admin-cli instance show + $ nico-admin-cli instance show Show a single instance by id: - $ carbide-admin-cli instance show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance show 12345678-1234-5678-90ab-cdef01234567 List instances for one tenant org: - $ carbide-admin-cli instance show --tenant-org-id fds34511233a + $ nico-admin-cli instance show --tenant-org-id fds34511233a List instances in a VPC: - $ carbide-admin-cli instance show --vpc-id abcdef01-2345-6789-abcd-ef0123456789 + $ nico-admin-cli instance show --vpc-id abcdef01-2345-6789-abcd-ef0123456789 List instances matching a label: - $ carbide-admin-cli instance show --label-key role --label-value training + $ nico-admin-cli instance show --label-key role --label-value training List instances of an instance type: - $ carbide-admin-cli instance show --instance-type-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance show --instance-type-id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/instance/update_ib_config/args.rs b/crates/admin-cli/src/instance/update_ib_config/args.rs index 1c8761d830..63a362f4dd 100644 --- a/crates/admin-cli/src/instance/update_ib_config/args.rs +++ b/crates/admin-cli/src/instance/update_ib_config/args.rs @@ -24,7 +24,7 @@ use rpc::InstanceInfinibandConfig; EXAMPLES: Update an instance's InfiniBand configuration: - $ carbide-admin-cli instance update-ib-config --instance 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance update-ib-config --instance 12345678-1234-5678-90ab-cdef01234567 \ --config '{\"partitions\":[]}' ")] diff --git a/crates/admin-cli/src/instance/update_nvlink_config/args.rs b/crates/admin-cli/src/instance/update_nvlink_config/args.rs index 1cd76d3119..db2cd7d925 100644 --- a/crates/admin-cli/src/instance/update_nvlink_config/args.rs +++ b/crates/admin-cli/src/instance/update_nvlink_config/args.rs @@ -24,7 +24,7 @@ use rpc::forge::InstanceNvLinkConfig; EXAMPLES: Update an instance's NVLink configuration: - $ carbide-admin-cli instance update-nv-link-config \ + $ nico-admin-cli instance update-nv-link-config \ --instance 12345678-1234-5678-90ab-cdef01234567 \ --config '{\"partition_id\":\"abcdef01-2345-6789-abcd-ef0123456789\"}' diff --git a/crates/admin-cli/src/instance/update_os/args.rs b/crates/admin-cli/src/instance/update_os/args.rs index cfdc4531ad..e91fc06288 100644 --- a/crates/admin-cli/src/instance/update_os/args.rs +++ b/crates/admin-cli/src/instance/update_os/args.rs @@ -24,7 +24,7 @@ use rpc::forge::InstanceOperatingSystemConfig; EXAMPLES: Update an instance's OS configuration: - $ carbide-admin-cli instance update-os --instance 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance update-os --instance 12345678-1234-5678-90ab-cdef01234567 \ --os '{\"os_image_id\":\"abcdef01-2345-6789-abcd-ef0123456789\"}' ")] diff --git a/crates/admin-cli/src/instance/update_spx_config/args.rs b/crates/admin-cli/src/instance/update_spx_config/args.rs index 247bfda14e..e47dc29415 100644 --- a/crates/admin-cli/src/instance/update_spx_config/args.rs +++ b/crates/admin-cli/src/instance/update_spx_config/args.rs @@ -24,7 +24,7 @@ use rpc::forge::InstanceSpxConfig; EXAMPLES: Update an instance's SPX configuration: - $ carbide-admin-cli instance update-spx-config \ + $ nico-admin-cli instance update-spx-config \ --instance 12345678-1234-5678-90ab-cdef01234567 \ --config '{\"partition_id\":\"abcdef01-2345-6789-abcd-ef0123456789\"}' diff --git a/crates/admin-cli/src/instance_type/associate/args.rs b/crates/admin-cli/src/instance_type/associate/args.rs index dcb8a26d7c..ddbf4a4e88 100644 --- a/crates/admin-cli/src/instance_type/associate/args.rs +++ b/crates/admin-cli/src/instance_type/associate/args.rs @@ -25,11 +25,11 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Associate one machine with an instance type: - $ carbide-admin-cli instance-type associate 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance-type associate 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 Associate several machines (comma-separated, no spaces): - $ carbide-admin-cli instance-type associate 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance-type associate 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789,11111111-2222-3333-4444-555555555555 ")] diff --git a/crates/admin-cli/src/instance_type/create/args.rs b/crates/admin-cli/src/instance_type/create/args.rs index 73fbd328bd..d92b02486e 100644 --- a/crates/admin-cli/src/instance_type/create/args.rs +++ b/crates/admin-cli/src/instance_type/create/args.rs @@ -25,16 +25,16 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Create an instance type with a name and description: - $ carbide-admin-cli instance-type create --name dgx-h100 \ + $ nico-admin-cli instance-type create --name dgx-h100 \ --description \"DGX H100 640GB\" Create with labels and desired-capability filters: - $ carbide-admin-cli instance-type create --name dgx-h100 \ + $ nico-admin-cli instance-type create --name dgx-h100 \ --labels '{\"tier\":\"premium\"}' \ --desired-capabilities '[{\"key\":\"gpu_count\",\"value\":\"8\"}]' Create with an explicit id: - $ carbide-admin-cli instance-type create --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance-type create --id 12345678-1234-5678-90ab-cdef01234567 \ --name dgx-h100 ")] diff --git a/crates/admin-cli/src/instance_type/delete/args.rs b/crates/admin-cli/src/instance_type/delete/args.rs index 0b069e835f..dbfdd1a3dc 100644 --- a/crates/admin-cli/src/instance_type/delete/args.rs +++ b/crates/admin-cli/src/instance_type/delete/args.rs @@ -23,7 +23,7 @@ use rpc::forge::DeleteInstanceTypeRequest; EXAMPLES: Delete an instance type by id: - $ carbide-admin-cli instance-type delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance-type delete --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/instance_type/disassociate/args.rs b/crates/admin-cli/src/instance_type/disassociate/args.rs index 8cf27a3fe9..c0bde7a5a1 100644 --- a/crates/admin-cli/src/instance_type/disassociate/args.rs +++ b/crates/admin-cli/src/instance_type/disassociate/args.rs @@ -24,7 +24,7 @@ use rpc::forge::RemoveMachineInstanceTypeAssociationRequest; EXAMPLES: Remove a machine's instance-type association: - $ carbide-admin-cli instance-type disassociate 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance-type disassociate 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/instance_type/show/args.rs b/crates/admin-cli/src/instance_type/show/args.rs index 93b8a4e749..960bb3c36b 100644 --- a/crates/admin-cli/src/instance_type/show/args.rs +++ b/crates/admin-cli/src/instance_type/show/args.rs @@ -22,13 +22,13 @@ use clap::Parser; EXAMPLES: List all instance types: - $ carbide-admin-cli instance-type show + $ nico-admin-cli instance-type show Show a single instance type by id: - $ carbide-admin-cli instance-type show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli instance-type show --id 12345678-1234-5678-90ab-cdef01234567 List instance types with allocation counts: - $ carbide-admin-cli instance-type show --show-stats true + $ nico-admin-cli instance-type show --show-stats true ")] pub struct Args { diff --git a/crates/admin-cli/src/instance_type/update/args.rs b/crates/admin-cli/src/instance_type/update/args.rs index 791ed69fd9..108b15532a 100644 --- a/crates/admin-cli/src/instance_type/update/args.rs +++ b/crates/admin-cli/src/instance_type/update/args.rs @@ -22,16 +22,16 @@ use clap::Parser; EXAMPLES: Rename an instance type: - $ carbide-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 \ --name dgx-h100-640gb Replace labels and capability filters (both overwrite completely): - $ carbide-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 \ --labels '{\"tier\":\"premium\"}' \ --desired-capabilities '[{\"key\":\"gpu_count\",\"value\":\"8\"}]' Update with optimistic concurrency on the record version: - $ carbide-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 \ --description \"DGX H100 640GB\" --version 3 ")] diff --git a/crates/admin-cli/src/inventory/args.rs b/crates/admin-cli/src/inventory/args.rs index 1f6f1e13a9..435f28c4fe 100644 --- a/crates/admin-cli/src/inventory/args.rs +++ b/crates/admin-cli/src/inventory/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Print the Ansible inventory to stdout: - $ carbide-admin-cli inventory + $ nico-admin-cli inventory Write the Ansible inventory to a file: - $ carbide-admin-cli inventory --filename ./inventory.ini + $ nico-admin-cli inventory --filename ./inventory.ini ")] pub struct Cmd { diff --git a/crates/admin-cli/src/ip/find/args.rs b/crates/admin-cli/src/ip/find/args.rs index 9c41453d41..174c19b77d 100644 --- a/crates/admin-cli/src/ip/find/args.rs +++ b/crates/admin-cli/src/ip/find/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Identify what owns an IPv4 address: - $ carbide-admin-cli ip find 192.0.2.10 + $ nico-admin-cli ip find 192.0.2.10 Identify what owns an IPv6 address: - $ carbide-admin-cli ip find 2001:db8::1 + $ nico-admin-cli ip find 2001:db8::1 ")] pub struct Args { diff --git a/crates/admin-cli/src/ipxe_template/show/args.rs b/crates/admin-cli/src/ipxe_template/show/args.rs index fa84d8dcb9..e72122f7ca 100644 --- a/crates/admin-cli/src/ipxe_template/show/args.rs +++ b/crates/admin-cli/src/ipxe_template/show/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: List all iPXE templates: - $ carbide-admin-cli ipxe-template show + $ nico-admin-cli ipxe-template show Show one iPXE template by ID: - $ carbide-admin-cli ipxe-template show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli ipxe-template show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/jump/args.rs b/crates/admin-cli/src/jump/args.rs index cc652ca76a..3bf00fee9e 100644 --- a/crates/admin-cli/src/jump/args.rs +++ b/crates/admin-cli/src/jump/args.rs @@ -22,13 +22,13 @@ use clap::Parser; EXAMPLES: Find an object by its UUID (machine, instance, VPC, etc.): - $ carbide-admin-cli jump 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli jump 12345678-1234-5678-90ab-cdef01234567 Find whatever owns an IP address: - $ carbide-admin-cli jump 192.0.2.10 + $ nico-admin-cli jump 192.0.2.10 Find a machine interface by its MAC address: - $ carbide-admin-cli jump 00:11:22:33:44:55 + $ nico-admin-cli jump 00:11:22:33:44:55 ")] pub struct Cmd { diff --git a/crates/admin-cli/src/machine/auto_update/args.rs b/crates/admin-cli/src/machine/auto_update/args.rs index 59ab0fb840..a548ef7f44 100644 --- a/crates/admin-cli/src/machine/auto_update/args.rs +++ b/crates/admin-cli/src/machine/auto_update/args.rs @@ -24,13 +24,13 @@ use clap::{ArgGroup, Parser}; EXAMPLES: Force-enable firmware auto-update for a host: - $ carbide-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --enable + $ nico-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --enable Force-disable it: - $ carbide-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --disable + $ nico-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --disable Clear the per-machine override (fall back to global/config): - $ carbide-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --clear + $ nico-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --clear ")] pub struct Args { diff --git a/crates/admin-cli/src/machine/force_delete/args.rs b/crates/admin-cli/src/machine/force_delete/args.rs index d99d79f184..d65d171e94 100644 --- a/crates/admin-cli/src/machine/force_delete/args.rs +++ b/crates/admin-cli/src/machine/force_delete/args.rs @@ -23,10 +23,10 @@ use rpc::forge::AdminForceDeleteMachineRequest; EXAMPLES: Force delete a machine (by UUID, IPv4, MAC, or hostname): - $ carbide-admin-cli machine force-delete --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine force-delete --machine 12345678-1234-5678-90ab-cdef01234567 Force delete a machine and its interfaces (redeploy kea afterward): - $ carbide-admin-cli machine force-delete --machine 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine force-delete --machine 12345678-1234-5678-90ab-cdef01234567 \ --delete-interfaces ")] diff --git a/crates/admin-cli/src/machine/hardware_info/args.rs b/crates/admin-cli/src/machine/hardware_info/args.rs index ff27e5ef8c..2173bd0f33 100644 --- a/crates/admin-cli/src/machine/hardware_info/args.rs +++ b/crates/admin-cli/src/machine/hardware_info/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Show a machine's hardware info: - $ carbide-admin-cli machine hardware-info show --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine hardware-info show --machine 12345678-1234-5678-90ab-cdef01234567 Update a machine's GPUs from a JSON file: - $ carbide-admin-cli machine hardware-info update gpus --machine 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine hardware-info update gpus --machine 12345678-1234-5678-90ab-cdef01234567 \ --gpu-json-file ./gpus.json ")] diff --git a/crates/admin-cli/src/machine/health_report/args.rs b/crates/admin-cli/src/machine/health_report/args.rs index 3356f665d0..18d133786e 100644 --- a/crates/admin-cli/src/machine/health_report/args.rs +++ b/crates/admin-cli/src/machine/health_report/args.rs @@ -23,18 +23,18 @@ use clap::{ArgGroup, Parser, ValueEnum}; EXAMPLES: List a machine's health report entries: - $ carbide-admin-cli machine health-report show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine health-report show 12345678-1234-5678-90ab-cdef01234567 Add a health report entry from a template: - $ carbide-admin-cli machine health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance --message \"Firmware upgrade in progress\" Remove a health report entry by its source: - $ carbide-admin-cli machine health-report remove 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine health-report remove 12345678-1234-5678-90ab-cdef01234567 \ internal-maintenance Print an empty health report template: - $ carbide-admin-cli machine health-report print-empty-template + $ nico-admin-cli machine health-report print-empty-template ")] pub enum Args { diff --git a/crates/admin-cli/src/machine/metadata/args.rs b/crates/admin-cli/src/machine/metadata/args.rs index e3e16a7c10..24d91c9f4e 100644 --- a/crates/admin-cli/src/machine/metadata/args.rs +++ b/crates/admin-cli/src/machine/metadata/args.rs @@ -37,7 +37,7 @@ pub enum Args { EXAMPLES: Show a machine's metadata: - $ carbide-admin-cli machine metadata show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine metadata show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct MachineMetadataCommandShow { @@ -50,7 +50,7 @@ pub struct MachineMetadataCommandShow { EXAMPLES: Set a machine's name and description: - $ carbide-admin-cli machine metadata set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine metadata set 12345678-1234-5678-90ab-cdef01234567 \ --name gpu-node-01 --description \"Rack 4, tray 2\" ")] @@ -68,10 +68,10 @@ pub struct MachineMetadataCommandSet { EXAMPLES: Add a key-only label: - $ carbide-admin-cli machine metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge + $ nico-admin-cli machine metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge Add a key/value label: - $ carbide-admin-cli machine metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ --key rack --value 4 ")] @@ -89,7 +89,7 @@ pub struct MachineMetadataCommandAddLabel { EXAMPLES: Remove one or more labels by key: - $ carbide-admin-cli machine metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ --keys rack --keys edge ")] @@ -105,10 +105,10 @@ pub struct MachineMetadataCommandRemoveLabels { EXAMPLES: Fill in missing metadata from the expected-machine (leaving existing values intact): - $ carbide-admin-cli machine metadata from-expected-machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine metadata from-expected-machine 12345678-1234-5678-90ab-cdef01234567 Overwrite the machine's metadata with the expected-machine's values: - $ carbide-admin-cli machine metadata from-expected-machine 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine metadata from-expected-machine 12345678-1234-5678-90ab-cdef01234567 \ --replace-all ")] diff --git a/crates/admin-cli/src/machine/network/args.rs b/crates/admin-cli/src/machine/network/args.rs index 026da2fa0b..41e916b13e 100644 --- a/crates/admin-cli/src/machine/network/args.rs +++ b/crates/admin-cli/src/machine/network/args.rs @@ -24,10 +24,10 @@ use super::super::common::NetworkConfigQuery; EXAMPLES: Print the network status of all machines: - $ carbide-admin-cli machine network status + $ nico-admin-cli machine network status Show the VPC network configuration for a DPU: - $ carbide-admin-cli machine network config --machine-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine network config --machine-id 12345678-1234-5678-90ab-cdef01234567 ")] pub enum Args { diff --git a/crates/admin-cli/src/machine/nvlink_info/args.rs b/crates/admin-cli/src/machine/nvlink_info/args.rs index bd882f375a..b3d9b71546 100644 --- a/crates/admin-cli/src/machine/nvlink_info/args.rs +++ b/crates/admin-cli/src/machine/nvlink_info/args.rs @@ -23,10 +23,10 @@ use clap::{Parser, Subcommand}; EXAMPLES: Show existing NVLink info for a machine: - $ carbide-admin-cli machine nvlink-info show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine nvlink-info show 12345678-1234-5678-90ab-cdef01234567 Build NVLink info from Redfish + NMX-C and persist it: - $ carbide-admin-cli machine nvlink-info populate 12345678-1234-5678-90ab-cdef01234567 --update-db + $ nico-admin-cli machine nvlink-info populate 12345678-1234-5678-90ab-cdef01234567 --update-db ")] pub enum Args { diff --git a/crates/admin-cli/src/machine/positions/args.rs b/crates/admin-cli/src/machine/positions/args.rs index aa33e1560a..b1e34ad9f9 100644 --- a/crates/admin-cli/src/machine/positions/args.rs +++ b/crates/admin-cli/src/machine/positions/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Show rack positions for all machines: - $ carbide-admin-cli machine positions + $ nico-admin-cli machine positions Show positions for specific machines: - $ carbide-admin-cli machine positions --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine positions --machine 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine/reboot/args.rs b/crates/admin-cli/src/machine/reboot/args.rs index 43a9eb0898..eb8a656478 100644 --- a/crates/admin-cli/src/machine/reboot/args.rs +++ b/crates/admin-cli/src/machine/reboot/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Reboot a machine: - $ carbide-admin-cli machine reboot --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine reboot --machine 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine/show/args.rs b/crates/admin-cli/src/machine/show/args.rs index 5beb8975bf..825f253bd2 100644 --- a/crates/admin-cli/src/machine/show/args.rs +++ b/crates/admin-cli/src/machine/show/args.rs @@ -24,14 +24,14 @@ use clap::Parser; EXAMPLES: List all machines: - $ carbide-admin-cli machine show + $ nico-admin-cli machine show Show one machine by ID: - $ carbide-admin-cli machine show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine show 12345678-1234-5678-90ab-cdef01234567 Show only DPUs (or only hosts): - $ carbide-admin-cli machine show --dpus - $ carbide-admin-cli machine show --hosts + $ nico-admin-cli machine show --dpus + $ nico-admin-cli machine show --hosts ")] pub struct Args { diff --git a/crates/admin-cli/src/machine_interfaces/assign_address/args.rs b/crates/admin-cli/src/machine_interfaces/assign_address/args.rs index 94b6a24313..3200bdcabb 100644 --- a/crates/admin-cli/src/machine_interfaces/assign_address/args.rs +++ b/crates/admin-cli/src/machine_interfaces/assign_address/args.rs @@ -25,7 +25,7 @@ use clap::Parser; EXAMPLES: Assign a static address to a machine interface: - $ carbide-admin-cli machine-interfaces assign-address 12345678-1234-5678-90ab-cdef01234567 192.0.2.20 + $ nico-admin-cli machine-interfaces assign-address 12345678-1234-5678-90ab-cdef01234567 192.0.2.20 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine_interfaces/delete/args.rs b/crates/admin-cli/src/machine_interfaces/delete/args.rs index 6695f3cde8..fcd0754c7e 100644 --- a/crates/admin-cli/src/machine_interfaces/delete/args.rs +++ b/crates/admin-cli/src/machine_interfaces/delete/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Delete a machine interface by ID (redeploy kea afterward): - $ carbide-admin-cli machine-interfaces delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine-interfaces delete 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine_interfaces/remove_address/args.rs b/crates/admin-cli/src/machine_interfaces/remove_address/args.rs index bf7e5c0a8e..5ce7184036 100644 --- a/crates/admin-cli/src/machine_interfaces/remove_address/args.rs +++ b/crates/admin-cli/src/machine_interfaces/remove_address/args.rs @@ -25,7 +25,7 @@ use clap::Parser; EXAMPLES: Remove a static address from a machine interface: - $ carbide-admin-cli machine-interfaces remove-address 12345678-1234-5678-90ab-cdef01234567 10.0.0.5 + $ nico-admin-cli machine-interfaces remove-address 12345678-1234-5678-90ab-cdef01234567 10.0.0.5 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine_interfaces/show/args.rs b/crates/admin-cli/src/machine_interfaces/show/args.rs index a4d5acdc07..9c0f33fae0 100644 --- a/crates/admin-cli/src/machine_interfaces/show/args.rs +++ b/crates/admin-cli/src/machine_interfaces/show/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: List all machine interfaces: - $ carbide-admin-cli machine-interfaces show + $ nico-admin-cli machine-interfaces show Show one machine interface by ID: - $ carbide-admin-cli machine-interfaces show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine-interfaces show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine_interfaces/show_addresses/args.rs b/crates/admin-cli/src/machine_interfaces/show_addresses/args.rs index 9b49bf2cd2..8b60419083 100644 --- a/crates/admin-cli/src/machine_interfaces/show_addresses/args.rs +++ b/crates/admin-cli/src/machine_interfaces/show_addresses/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Show the addresses on a machine interface: - $ carbide-admin-cli machine-interfaces show-addresses 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine-interfaces show-addresses 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/machine_validation/external_config/args.rs b/crates/admin-cli/src/machine_validation/external_config/args.rs index 5e635ba42a..ed195febd7 100644 --- a/crates/admin-cli/src/machine_validation/external_config/args.rs +++ b/crates/admin-cli/src/machine_validation/external_config/args.rs @@ -22,14 +22,14 @@ use clap::Parser; EXAMPLES: Show external config entries by name: - $ carbide-admin-cli machine-validation external-config show --name my-config + $ nico-admin-cli machine-validation external-config show --name my-config Add or update an external config from a file: - $ carbide-admin-cli machine-validation external-config add-update --name my-config \ + $ nico-admin-cli machine-validation external-config add-update --name my-config \ --file-name ./config.toml --description \"validation overrides\" Remove an external config: - $ carbide-admin-cli machine-validation external-config remove --name my-config + $ nico-admin-cli machine-validation external-config remove --name my-config ")] pub enum Args { diff --git a/crates/admin-cli/src/machine_validation/on_demand/args.rs b/crates/admin-cli/src/machine_validation/on_demand/args.rs index 58d7bf3bdd..974d524ed9 100644 --- a/crates/admin-cli/src/machine_validation/on_demand/args.rs +++ b/crates/admin-cli/src/machine_validation/on_demand/args.rs @@ -23,11 +23,11 @@ use clap::Parser; EXAMPLES: Start on-demand validation for a machine: - $ carbide-admin-cli machine-validation on-demand start --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine-validation on-demand start --machine 12345678-1234-5678-90ab-cdef01234567 Start with a restricted set of allowed tests, including unverified: - $ carbide-admin-cli machine-validation on-demand start --machine 12345678-1234-5678-90ab-cdef01234567 \ - --allowed-tests gpu_bandwidth --run-unverfied-tests + $ nico-admin-cli machine-validation on-demand start --machine 12345678-1234-5678-90ab-cdef01234567 \ + --allowed-tests gpu_bandwidth --run-unverified-tests ")] pub enum Args { @@ -50,8 +50,8 @@ pub struct OnDemandOptions { #[clap(long, help = "Allowed tests")] pub allowed_tests: Option>, - #[clap(long, default_value = "false", help = "Run not verfified tests")] - pub run_unverfied_tests: bool, + #[clap(long, default_value = "false", help = "Run unverified tests")] + pub run_unverified_tests: bool, #[clap(long, help = "Contexts")] pub contexts: Option>, diff --git a/crates/admin-cli/src/machine_validation/on_demand/cmd.rs b/crates/admin-cli/src/machine_validation/on_demand/cmd.rs index e828b182a2..b89361b278 100644 --- a/crates/admin-cli/src/machine_validation/on_demand/cmd.rs +++ b/crates/admin-cli/src/machine_validation/on_demand/cmd.rs @@ -28,7 +28,7 @@ pub async fn on_demand_machine_validation( args.machine, args.tags, args.allowed_tests, - args.run_unverfied_tests, + args.run_unverified_tests, args.contexts, ) .await?; diff --git a/crates/admin-cli/src/machine_validation/results/args.rs b/crates/admin-cli/src/machine_validation/results/args.rs index 1919bbdf3d..d7c90f7269 100644 --- a/crates/admin-cli/src/machine_validation/results/args.rs +++ b/crates/admin-cli/src/machine_validation/results/args.rs @@ -24,13 +24,13 @@ use clap::{ArgGroup, Parser}; EXAMPLES: Show validation results for a machine: - $ carbide-admin-cli machine-validation results show --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine-validation results show --machine 12345678-1234-5678-90ab-cdef01234567 Show results for a specific validation run: - $ carbide-admin-cli machine-validation results show --validation-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli machine-validation results show --validation-id 12345678-1234-5678-90ab-cdef01234567 Show one test's result within a run (with history): - $ carbide-admin-cli machine-validation results show --validation-id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine-validation results show --validation-id 12345678-1234-5678-90ab-cdef01234567 \ --test-name gpu_bandwidth --history ")] diff --git a/crates/admin-cli/src/machine_validation/runs/args.rs b/crates/admin-cli/src/machine_validation/runs/args.rs index 6dcf773266..c290b2dd8c 100644 --- a/crates/admin-cli/src/machine_validation/runs/args.rs +++ b/crates/admin-cli/src/machine_validation/runs/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Show all validation runs: - $ carbide-admin-cli machine-validation runs show + $ nico-admin-cli machine-validation runs show Show runs for one machine, including history: - $ carbide-admin-cli machine-validation runs show --machine 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli machine-validation runs show --machine 12345678-1234-5678-90ab-cdef01234567 \ --history ")] diff --git a/crates/admin-cli/src/machine_validation/tests.rs b/crates/admin-cli/src/machine_validation/tests.rs index 81f09a3e4a..19354db986 100644 --- a/crates/admin-cli/src/machine_validation/tests.rs +++ b/crates/admin-cli/src/machine_validation/tests.rs @@ -105,7 +105,7 @@ fn parse_on_demand_start() { match cmd { Cmd::OnDemand(on_demand::Args::Start(args)) => { assert_eq!(args.machine.to_string(), TEST_MACHINE_ID); - assert!(!args.run_unverfied_tests); + assert!(!args.run_unverified_tests); } _ => panic!("expected OnDemand Start variant"), } diff --git a/crates/admin-cli/src/machine_validation/tests_cmd/args.rs b/crates/admin-cli/src/machine_validation/tests_cmd/args.rs index 65ce88cf90..0be6e6b099 100644 --- a/crates/admin-cli/src/machine_validation/tests_cmd/args.rs +++ b/crates/admin-cli/src/machine_validation/tests_cmd/args.rs @@ -22,14 +22,14 @@ use clap::Parser; EXAMPLES: List supported tests (optionally including unverified): - $ carbide-admin-cli machine-validation tests show + $ nico-admin-cli machine-validation tests show Verify a test version: - $ carbide-admin-cli machine-validation tests verify --test-id gpu_bandwidth --version 1.2.0 + $ nico-admin-cli machine-validation tests verify --test-id gpu_bandwidth --version 1.2.0 Enable / disable a test version: - $ carbide-admin-cli machine-validation tests enable --test-id gpu_bandwidth --version 1.2.0 - $ carbide-admin-cli machine-validation tests disable --test-id gpu_bandwidth --version 1.2.0 + $ nico-admin-cli machine-validation tests enable --test-id gpu_bandwidth --version 1.2.0 + $ nico-admin-cli machine-validation tests disable --test-id gpu_bandwidth --version 1.2.0 ")] pub enum Args { diff --git a/crates/admin-cli/src/managed_host/debug_bundle/args.rs b/crates/admin-cli/src/managed_host/debug_bundle/args.rs index 6d21b882be..956b3af4b5 100644 --- a/crates/admin-cli/src/managed_host/debug_bundle/args.rs +++ b/crates/admin-cli/src/managed_host/debug_bundle/args.rs @@ -22,11 +22,11 @@ use clap::Parser; EXAMPLES: Download a debug bundle for a host over a time range: - $ carbide-admin-cli managed-host debug-bundle 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host debug-bundle 12345678-1234-5678-90ab-cdef01234567 \ --start-time \"2026-01-02 03:04:05\" --end-time \"2026-01-02 04:00:00\" Collect from a start time to now, interpreting times as UTC: - $ carbide-admin-cli managed-host debug-bundle 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host debug-bundle 12345678-1234-5678-90ab-cdef01234567 \ --start-time 03:04:05 --utc ")] diff --git a/crates/admin-cli/src/managed_host/maintenance/args.rs b/crates/admin-cli/src/managed_host/maintenance/args.rs index 592d439ed6..8ff7f9f433 100644 --- a/crates/admin-cli/src/managed_host/maintenance/args.rs +++ b/crates/admin-cli/src/managed_host/maintenance/args.rs @@ -20,7 +20,7 @@ use clap::Parser; use rpc::forge as forgerpc; /// Enable or disable maintenance mode on a managed host. -/// To list machines in maintenance mode use `carbide-admin-cli mh show --all --fix` +/// To list machines in maintenance mode use `nico-admin-cli mh show --all --fix` #[derive(Parser, Debug)] pub enum Args { /// Put this machine into maintenance mode. Prevents an instance being assigned to it. @@ -34,7 +34,7 @@ pub enum Args { EXAMPLES: Put a host into maintenance mode (prevents instance assignment): - $ carbide-admin-cli managed-host maintenance on --host 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host maintenance on --host 12345678-1234-5678-90ab-cdef01234567 \ --reference https://tickets.example.com/MH-42 ")] @@ -66,7 +66,7 @@ impl From for forgerpc::MaintenanceRequest { EXAMPLES: Return a host to normal operation: - $ carbide-admin-cli managed-host maintenance off --host 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-host maintenance off --host 12345678-1234-5678-90ab-cdef01234567 ")] pub struct MaintenanceOff { diff --git a/crates/admin-cli/src/managed_host/power_options/args.rs b/crates/admin-cli/src/managed_host/power_options/args.rs index dc857de318..29840db61b 100644 --- a/crates/admin-cli/src/managed_host/power_options/args.rs +++ b/crates/admin-cli/src/managed_host/power_options/args.rs @@ -25,10 +25,10 @@ pub enum Args { EXAMPLES: Show power options for all hosts: - $ carbide-admin-cli managed-host power-options show + $ nico-admin-cli managed-host power-options show Show power options for one host: - $ carbide-admin-cli managed-host power-options show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-host power-options show 12345678-1234-5678-90ab-cdef01234567 ")] Show(ShowPowerOptions), @@ -36,7 +36,7 @@ Show power options for one host: EXAMPLES: Set a host's desired power state (on / off / power-manager-disabled): - $ carbide-admin-cli managed-host power-options update 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host power-options update 12345678-1234-5678-90ab-cdef01234567 \ --desired-power-state off ")] @@ -46,7 +46,7 @@ Set a host's desired power state (on / off / power-manager-disabled): EXAMPLES: Get the ingestion state for a machine by its BMC MAC: - $ carbide-admin-cli managed-host power-options get-machine-ingestion-state \ + $ nico-admin-cli managed-host power-options get-machine-ingestion-state \ --mac-address 00:11:22:33:44:55 ")] @@ -56,7 +56,7 @@ Get the ingestion state for a machine by its BMC MAC: EXAMPLES: Allow a machine to be ingested and powered on: - $ carbide-admin-cli managed-host power-options allow-ingestion-and-power-on \ + $ nico-admin-cli managed-host power-options allow-ingestion-and-power-on \ --mac-address 00:11:22:33:44:55 ")] diff --git a/crates/admin-cli/src/managed_host/quarantine/args.rs b/crates/admin-cli/src/managed_host/quarantine/args.rs index d0b6ad04dc..ede4dd05f0 100644 --- a/crates/admin-cli/src/managed_host/quarantine/args.rs +++ b/crates/admin-cli/src/managed_host/quarantine/args.rs @@ -33,7 +33,7 @@ pub enum Args { EXAMPLES: Quarantine a host (blocks all host network traffic): - $ carbide-admin-cli managed-host quarantine on --host 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host quarantine on --host 12345678-1234-5678-90ab-cdef01234567 \ --reason \"suspected compromise\" ")] @@ -67,7 +67,7 @@ impl From for forgerpc::SetManagedHostQuarantineStateRequest { EXAMPLES: Take a host out of quarantine: - $ carbide-admin-cli managed-host quarantine off --host 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-host quarantine off --host 12345678-1234-5678-90ab-cdef01234567 ")] pub struct QuarantineOff { diff --git a/crates/admin-cli/src/managed_host/reset_host_reprovisioning/args.rs b/crates/admin-cli/src/managed_host/reset_host_reprovisioning/args.rs index 804f3fb3a9..f1f33ae9fd 100644 --- a/crates/admin-cli/src/managed_host/reset_host_reprovisioning/args.rs +++ b/crates/admin-cli/src/managed_host/reset_host_reprovisioning/args.rs @@ -24,7 +24,7 @@ use clap::Parser; EXAMPLES: Reset a host's reprovisioning back to CheckingFirmware: - $ carbide-admin-cli managed-host reset-host-reprovisioning --machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-host reset-host-reprovisioning --machine 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/managed_host/set_primary_dpu/args.rs b/crates/admin-cli/src/managed_host/set_primary_dpu/args.rs index 512cb7b443..6a457e57c5 100644 --- a/crates/admin-cli/src/managed_host/set_primary_dpu/args.rs +++ b/crates/admin-cli/src/managed_host/set_primary_dpu/args.rs @@ -24,11 +24,11 @@ use rpc::forge as forgerpc; EXAMPLES: Set the primary DPU for a host: - $ carbide-admin-cli managed-host set-primary-dpu 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host set-primary-dpu 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 Set the primary DPU and reboot the host afterward: - $ carbide-admin-cli managed-host set-primary-dpu 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host set-primary-dpu 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 --reboot ")] diff --git a/crates/admin-cli/src/managed_host/show/args.rs b/crates/admin-cli/src/managed_host/show/args.rs index 5378630321..d9633556b0 100644 --- a/crates/admin-cli/src/managed_host/show/args.rs +++ b/crates/admin-cli/src/managed_host/show/args.rs @@ -24,13 +24,13 @@ use clap::Parser; EXAMPLES: List all managed hosts: - $ carbide-admin-cli managed-host show + $ nico-admin-cli managed-host show Show details for one host (by host or DPU machine ID): - $ carbide-admin-cli managed-host show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-host show 12345678-1234-5678-90ab-cdef01234567 Show the summary with IP details: - $ carbide-admin-cli managed-host show --ips + $ nico-admin-cli managed-host show --ips ")] pub struct Args { diff --git a/crates/admin-cli/src/managed_host/start_updates/args.rs b/crates/admin-cli/src/managed_host/start_updates/args.rs index 18e452b8f6..00ca245415 100644 --- a/crates/admin-cli/src/managed_host/start_updates/args.rs +++ b/crates/admin-cli/src/managed_host/start_updates/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Start delayed updates for one or more machines now: - $ carbide-admin-cli managed-host start-updates --machines 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-host start-updates --machines 12345678-1234-5678-90ab-cdef01234567 Schedule the update window for a specific start time: - $ carbide-admin-cli managed-host start-updates --machines 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli managed-host start-updates --machines 12345678-1234-5678-90ab-cdef01234567 \ --start 2026-01-02T03:04:05 ")] diff --git a/crates/admin-cli/src/managed_switch/delete/args.rs b/crates/admin-cli/src/managed_switch/delete/args.rs index 2e7dc2a579..2c2f6c35d2 100644 --- a/crates/admin-cli/src/managed_switch/delete/args.rs +++ b/crates/admin-cli/src/managed_switch/delete/args.rs @@ -25,7 +25,7 @@ use clap::Parser; EXAMPLES: Delete a managed switch by ID: - $ carbide-admin-cli managed-switch delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-switch delete 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/managed_switch/list/args.rs b/crates/admin-cli/src/managed_switch/list/args.rs index c419ba29c8..fa54c8b2b9 100644 --- a/crates/admin-cli/src/managed_switch/list/args.rs +++ b/crates/admin-cli/src/managed_switch/list/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: List all managed switches: - $ carbide-admin-cli managed-switch list + $ nico-admin-cli managed-switch list ")] pub struct Args; diff --git a/crates/admin-cli/src/managed_switch/show/args.rs b/crates/admin-cli/src/managed_switch/show/args.rs index 332f704700..40060a9fe7 100644 --- a/crates/admin-cli/src/managed_switch/show/args.rs +++ b/crates/admin-cli/src/managed_switch/show/args.rs @@ -25,10 +25,10 @@ use clap::Parser; EXAMPLES: List all managed switches: - $ carbide-admin-cli managed-switch show + $ nico-admin-cli managed-switch show Show one managed switch by ID or name: - $ carbide-admin-cli managed-switch show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli managed-switch show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/mlx/config/args.rs b/crates/admin-cli/src/mlx/config/args.rs index 5ea32b2752..197e8d0685 100644 --- a/crates/admin-cli/src/mlx/config/args.rs +++ b/crates/admin-cli/src/mlx/config/args.rs @@ -30,14 +30,14 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Query device configuration values (all, or specific comma-separated variables): - $ carbide-admin-cli mlx config query 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry + $ nico-admin-cli mlx config query 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry Set configuration values (variable=value, comma-separated): - $ carbide-admin-cli mlx config set 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry \ + $ nico-admin-cli mlx config set 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry \ LINK_TYPE=eth,SRIOV_EN=true Compare a device against expected values: - $ carbide-admin-cli mlx config compare 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry \ + $ nico-admin-cli mlx config compare 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry \ LINK_TYPE=eth ")] diff --git a/crates/admin-cli/src/mlx/connections/args.rs b/crates/admin-cli/src/mlx/connections/args.rs index 00910ebc79..5a386e3ab6 100644 --- a/crates/admin-cli/src/mlx/connections/args.rs +++ b/crates/admin-cli/src/mlx/connections/args.rs @@ -28,10 +28,10 @@ use rpc::protos::forge as forge_pb; EXAMPLES: Show all active scout stream connections: - $ carbide-admin-cli mlx connections show + $ nico-admin-cli mlx connections show Disconnect a machine's scout stream connection: - $ carbide-admin-cli mlx connections disconnect 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli mlx connections disconnect 12345678-1234-5678-90ab-cdef01234567 ")] pub enum ConnectionsCommand { diff --git a/crates/admin-cli/src/mlx/info/args.rs b/crates/admin-cli/src/mlx/info/args.rs index d184d287fd..2caade624a 100644 --- a/crates/admin-cli/src/mlx/info/args.rs +++ b/crates/admin-cli/src/mlx/info/args.rs @@ -28,10 +28,10 @@ use rpc::protos::mlx_device as mlx_device_pb; EXAMPLES: Get device info for one device on a machine: - $ carbide-admin-cli mlx info device 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 + $ nico-admin-cli mlx info device 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 Get the full device report for a machine: - $ carbide-admin-cli mlx info machine 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli mlx info machine 12345678-1234-5678-90ab-cdef01234567 ")] pub enum InfoCommand { diff --git a/crates/admin-cli/src/mlx/lockdown/args.rs b/crates/admin-cli/src/mlx/lockdown/args.rs index 3d925d825c..56902d7a9c 100644 --- a/crates/admin-cli/src/mlx/lockdown/args.rs +++ b/crates/admin-cli/src/mlx/lockdown/args.rs @@ -28,13 +28,13 @@ use rpc::protos::mlx_device as mlx_device_pb; EXAMPLES: Lock hardware access on a device: - $ carbide-admin-cli mlx lockdown lock 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 + $ nico-admin-cli mlx lockdown lock 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 Unlock hardware access on a device: - $ carbide-admin-cli mlx lockdown unlock 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 + $ nico-admin-cli mlx lockdown unlock 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 Check a device's lockdown status: - $ carbide-admin-cli mlx lockdown status 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 + $ nico-admin-cli mlx lockdown status 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 ")] pub enum LockdownCommand { diff --git a/crates/admin-cli/src/mlx/profile/args.rs b/crates/admin-cli/src/mlx/profile/args.rs index 39476ccfdd..345bfc11be 100644 --- a/crates/admin-cli/src/mlx/profile/args.rs +++ b/crates/admin-cli/src/mlx/profile/args.rs @@ -28,17 +28,17 @@ use rpc::protos::mlx_device as mlx_device_pb; EXAMPLES: List all available profiles: - $ carbide-admin-cli mlx profile list + $ nico-admin-cli mlx profile list Show a profile's details: - $ carbide-admin-cli mlx profile show my-profile + $ nico-admin-cli mlx profile show my-profile Sync a profile to a device on a machine: - $ carbide-admin-cli mlx profile sync 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 \ + $ nico-admin-cli mlx profile sync 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 \ --profile-name my-profile Compare a device against a profile: - $ carbide-admin-cli mlx profile compare 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 \ + $ nico-admin-cli mlx profile compare 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 \ --profile-name my-profile ")] diff --git a/crates/admin-cli/src/mlx/registry/args.rs b/crates/admin-cli/src/mlx/registry/args.rs index 202e128b67..90904cfd0d 100644 --- a/crates/admin-cli/src/mlx/registry/args.rs +++ b/crates/admin-cli/src/mlx/registry/args.rs @@ -28,10 +28,10 @@ use rpc::protos::mlx_device as mlx_device_pb; EXAMPLES: List the variable registries available on a machine: - $ carbide-admin-cli mlx registry list 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli mlx registry list 12345678-1234-5678-90ab-cdef01234567 Show one registry's details: - $ carbide-admin-cli mlx registry show 12345678-1234-5678-90ab-cdef01234567 my-registry + $ nico-admin-cli mlx registry show 12345678-1234-5678-90ab-cdef01234567 my-registry ")] pub enum RegistryCommand { diff --git a/crates/admin-cli/src/network_devices/show/args.rs b/crates/admin-cli/src/network_devices/show/args.rs index 349244cd6b..bb62bd90ea 100644 --- a/crates/admin-cli/src/network_devices/show/args.rs +++ b/crates/admin-cli/src/network_devices/show/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Show the full network topology (all devices): - $ carbide-admin-cli network-device show + $ nico-admin-cli network-device show Show one network device by MAC: - $ carbide-admin-cli network-device show mac=00:11:22:33:44:55 + $ nico-admin-cli network-device show mac=00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/network_security_group/attach/args.rs b/crates/admin-cli/src/network_security_group/attach/args.rs index 1a179c6c7e..f8a57a3911 100644 --- a/crates/admin-cli/src/network_security_group/attach/args.rs +++ b/crates/admin-cli/src/network_security_group/attach/args.rs @@ -24,11 +24,11 @@ use clap::Parser; EXAMPLES: Attach a network security group to a VPC: - $ carbide-admin-cli network-security-group attach --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli network-security-group attach --id 12345678-1234-5678-90ab-cdef01234567 \ --vpc-id abcdef01-2345-6789-abcd-ef0123456789 Attach it to a single instance: - $ carbide-admin-cli network-security-group attach --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli network-security-group attach --id 12345678-1234-5678-90ab-cdef01234567 \ --instance-id abcdef01-2345-6789-abcd-ef0123456789 ")] diff --git a/crates/admin-cli/src/network_security_group/create/args.rs b/crates/admin-cli/src/network_security_group/create/args.rs index 064073a79a..e305f22d3c 100644 --- a/crates/admin-cli/src/network_security_group/create/args.rs +++ b/crates/admin-cli/src/network_security_group/create/args.rs @@ -27,11 +27,11 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Create a network security group for a tenant: - $ carbide-admin-cli network-security-group create --tenant-organization-id fds34511233a \ + $ nico-admin-cli network-security-group create --tenant-organization-id fds34511233a \ --name web-tier Create one with stateful egress and labels: - $ carbide-admin-cli network-security-group create --tenant-organization-id fds34511233a \ + $ nico-admin-cli network-security-group create --tenant-organization-id fds34511233a \ --name web-tier --stateful-egress --labels '{\"env\":\"prod\"}' ")] diff --git a/crates/admin-cli/src/network_security_group/delete/args.rs b/crates/admin-cli/src/network_security_group/delete/args.rs index ab42486f21..2e033cb9b3 100644 --- a/crates/admin-cli/src/network_security_group/delete/args.rs +++ b/crates/admin-cli/src/network_security_group/delete/args.rs @@ -23,7 +23,7 @@ use rpc::forge::DeleteNetworkSecurityGroupRequest; EXAMPLES: Delete a network security group: - $ carbide-admin-cli network-security-group delete --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli network-security-group delete --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a ")] diff --git a/crates/admin-cli/src/network_security_group/detach/args.rs b/crates/admin-cli/src/network_security_group/detach/args.rs index d95c71cf28..b0e98ae3f9 100644 --- a/crates/admin-cli/src/network_security_group/detach/args.rs +++ b/crates/admin-cli/src/network_security_group/detach/args.rs @@ -24,10 +24,10 @@ use clap::Parser; EXAMPLES: Remove the network security group from a VPC: - $ carbide-admin-cli network-security-group detach --vpc-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli network-security-group detach --vpc-id 12345678-1234-5678-90ab-cdef01234567 Remove it from a single instance: - $ carbide-admin-cli network-security-group detach --instance-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli network-security-group detach --instance-id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/network_security_group/show/args.rs b/crates/admin-cli/src/network_security_group/show/args.rs index 017184cf9c..c5554b1fd3 100644 --- a/crates/admin-cli/src/network_security_group/show/args.rs +++ b/crates/admin-cli/src/network_security_group/show/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: List all network security groups: - $ carbide-admin-cli network-security-group show + $ nico-admin-cli network-security-group show Show one network security group by ID: - $ carbide-admin-cli network-security-group show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli network-security-group show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/network_security_group/show_attachments/args.rs b/crates/admin-cli/src/network_security_group/show_attachments/args.rs index 5df704f92c..f101940024 100644 --- a/crates/admin-cli/src/network_security_group/show_attachments/args.rs +++ b/crates/admin-cli/src/network_security_group/show_attachments/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Show what is attached to a network security group: - $ carbide-admin-cli network-security-group show-attachments --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli network-security-group show-attachments --id 12345678-1234-5678-90ab-cdef01234567 Include objects inheriting the group from a parent: - $ carbide-admin-cli network-security-group show-attachments --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli network-security-group show-attachments --id 12345678-1234-5678-90ab-cdef01234567 \ --include-indirect ")] diff --git a/crates/admin-cli/src/network_security_group/update/args.rs b/crates/admin-cli/src/network_security_group/update/args.rs index 78df36c701..85a5447ed5 100644 --- a/crates/admin-cli/src/network_security_group/update/args.rs +++ b/crates/admin-cli/src/network_security_group/update/args.rs @@ -22,11 +22,11 @@ use clap::Parser; EXAMPLES: Rename a network security group: - $ carbide-admin-cli network-security-group update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli network-security-group update --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a --name web-tier Replace its rule set from JSON (overwrites all existing rules): - $ carbide-admin-cli network-security-group update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli network-security-group update --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-organization-id fds34511233a --rules '[...]' ")] diff --git a/crates/admin-cli/src/network_segment/delete/args.rs b/crates/admin-cli/src/network_segment/delete/args.rs index b230d18520..78904b77df 100644 --- a/crates/admin-cli/src/network_segment/delete/args.rs +++ b/crates/admin-cli/src/network_segment/delete/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Delete a network segment by ID: - $ carbide-admin-cli network-segment delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli network-segment delete --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/network_segment/show/args.rs b/crates/admin-cli/src/network_segment/show/args.rs index ade316a98b..525208f375 100644 --- a/crates/admin-cli/src/network_segment/show/args.rs +++ b/crates/admin-cli/src/network_segment/show/args.rs @@ -23,13 +23,13 @@ use clap::Parser; EXAMPLES: List all network segments: - $ carbide-admin-cli network-segment show + $ nico-admin-cli network-segment show Show one network segment by ID: - $ carbide-admin-cli network-segment show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli network-segment show 12345678-1234-5678-90ab-cdef01234567 Filter by tenant org: - $ carbide-admin-cli network-segment show --tenant-org-id fds34511233a + $ nico-admin-cli network-segment show --tenant-org-id fds34511233a ")] pub struct Args { diff --git a/crates/admin-cli/src/nvl_domain/health_report/args.rs b/crates/admin-cli/src/nvl_domain/health_report/args.rs index 43473a9e51..7e80204be4 100644 --- a/crates/admin-cli/src/nvl_domain/health_report/args.rs +++ b/crates/admin-cli/src/nvl_domain/health_report/args.rs @@ -23,14 +23,14 @@ use clap::Parser; EXAMPLES: List the health report sources for an NVLink domain: - $ carbide-admin-cli nvl-domain health-report show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli nvl-domain health-report show 12345678-1234-5678-90ab-cdef01234567 Remove a health report source (source name from `health-report show`): - $ carbide-admin-cli nvl-domain health-report remove 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli nvl-domain health-report remove 12345678-1234-5678-90ab-cdef01234567 \ internal-maintenance Print an empty health report template: - $ carbide-admin-cli nvl-domain health-report print-empty-template + $ nico-admin-cli nvl-domain health-report print-empty-template ")] pub enum Args { diff --git a/crates/admin-cli/src/nvl_logical_partition/create/args.rs b/crates/admin-cli/src/nvl_logical_partition/create/args.rs index 6fb6fbed82..5aac1bab30 100644 --- a/crates/admin-cli/src/nvl_logical_partition/create/args.rs +++ b/crates/admin-cli/src/nvl_logical_partition/create/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Create a logical partition for a tenant: - $ carbide-admin-cli logical-partition create --name my-partition \ + $ nico-admin-cli logical-partition create --name my-partition \ --tenant-organization-id fds34511233a ")] diff --git a/crates/admin-cli/src/nvl_logical_partition/delete/args.rs b/crates/admin-cli/src/nvl_logical_partition/delete/args.rs index 2855ec83ee..fe63111066 100644 --- a/crates/admin-cli/src/nvl_logical_partition/delete/args.rs +++ b/crates/admin-cli/src/nvl_logical_partition/delete/args.rs @@ -26,7 +26,7 @@ use crate::errors::CarbideCliError; EXAMPLES: Delete a logical partition by name: - $ carbide-admin-cli logical-partition delete --name my-partition + $ nico-admin-cli logical-partition delete --name my-partition ")] pub struct Args { diff --git a/crates/admin-cli/src/nvl_logical_partition/show/args.rs b/crates/admin-cli/src/nvl_logical_partition/show/args.rs index 994adef38d..9117aaf0a0 100644 --- a/crates/admin-cli/src/nvl_logical_partition/show/args.rs +++ b/crates/admin-cli/src/nvl_logical_partition/show/args.rs @@ -22,13 +22,13 @@ use clap::Parser; EXAMPLES: List all logical partitions: - $ carbide-admin-cli logical-partition show + $ nico-admin-cli logical-partition show Show one logical partition by ID: - $ carbide-admin-cli logical-partition show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli logical-partition show 12345678-1234-5678-90ab-cdef01234567 Filter by name: - $ carbide-admin-cli logical-partition show --name my-partition + $ nico-admin-cli logical-partition show --name my-partition ")] pub struct Args { diff --git a/crates/admin-cli/src/nvl_partition/show/args.rs b/crates/admin-cli/src/nvl_partition/show/args.rs index 0d263b2dcc..228b7beffc 100644 --- a/crates/admin-cli/src/nvl_partition/show/args.rs +++ b/crates/admin-cli/src/nvl_partition/show/args.rs @@ -22,16 +22,16 @@ use clap::Parser; EXAMPLES: List all NvLink partitions: - $ carbide-admin-cli nvl-partition show + $ nico-admin-cli nvl-partition show Show one NvLink partition by ID: - $ carbide-admin-cli nvl-partition show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli nvl-partition show 12345678-1234-5678-90ab-cdef01234567 Filter by tenant org: - $ carbide-admin-cli nvl-partition show --tenant-org-id fds34511233a + $ nico-admin-cli nvl-partition show --tenant-org-id fds34511233a Filter by name: - $ carbide-admin-cli nvl-partition show --name my-partition + $ nico-admin-cli nvl-partition show --name my-partition ")] pub struct Args { diff --git a/crates/admin-cli/src/nvlink_nmxc_endpoints/create.rs b/crates/admin-cli/src/nvlink_nmxc_endpoints/create.rs index 3e78624325..b701f8f83e 100644 --- a/crates/admin-cli/src/nvlink_nmxc_endpoints/create.rs +++ b/crates/admin-cli/src/nvlink_nmxc_endpoints/create.rs @@ -15,7 +15,7 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Insert a chassis serial to NMX-C endpoint mapping: - $ carbide-admin-cli nvlink-nmxc-endpoints create --chassis-serial 1234567890123 \ + $ nico-admin-cli nvlink-nmxc-endpoints create --chassis-serial 1234567890123 \ --endpoint https://192.0.2.10:50051 ")] diff --git a/crates/admin-cli/src/nvlink_nmxc_endpoints/delete.rs b/crates/admin-cli/src/nvlink_nmxc_endpoints/delete.rs index af59fa7d71..9ab57ffe16 100644 --- a/crates/admin-cli/src/nvlink_nmxc_endpoints/delete.rs +++ b/crates/admin-cli/src/nvlink_nmxc_endpoints/delete.rs @@ -15,7 +15,7 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Remove the mapping for a chassis serial: - $ carbide-admin-cli nvlink-nmxc-endpoints delete --chassis-serial 1234567890123 + $ nico-admin-cli nvlink-nmxc-endpoints delete --chassis-serial 1234567890123 ")] pub struct Args { diff --git a/crates/admin-cli/src/nvlink_nmxc_endpoints/show.rs b/crates/admin-cli/src/nvlink_nmxc_endpoints/show.rs index 3b9be12724..966644cfc0 100644 --- a/crates/admin-cli/src/nvlink_nmxc_endpoints/show.rs +++ b/crates/admin-cli/src/nvlink_nmxc_endpoints/show.rs @@ -17,10 +17,10 @@ use crate::rpc::ApiClient; EXAMPLES: List all chassis serial to NMX-C endpoint mappings: - $ carbide-admin-cli nvlink-nmxc-endpoints show + $ nico-admin-cli nvlink-nmxc-endpoints show Show the mapping for one chassis serial: - $ carbide-admin-cli nvlink-nmxc-endpoints show --chassis-serial 1234567890123 + $ nico-admin-cli nvlink-nmxc-endpoints show --chassis-serial 1234567890123 ")] pub struct Args { diff --git a/crates/admin-cli/src/nvlink_nmxc_endpoints/update.rs b/crates/admin-cli/src/nvlink_nmxc_endpoints/update.rs index 1ae8614ce5..7550ee6060 100644 --- a/crates/admin-cli/src/nvlink_nmxc_endpoints/update.rs +++ b/crates/admin-cli/src/nvlink_nmxc_endpoints/update.rs @@ -15,7 +15,7 @@ use crate::errors::{CarbideCliError, CarbideCliResult}; EXAMPLES: Change the NMX-C endpoint URL for a chassis serial: - $ carbide-admin-cli nvlink-nmxc-endpoints update --chassis-serial 1234567890123 \ + $ nico-admin-cli nvlink-nmxc-endpoints update --chassis-serial 1234567890123 \ --endpoint https://192.0.2.20:50051 ")] diff --git a/crates/admin-cli/src/operating_system/create/args.rs b/crates/admin-cli/src/operating_system/create/args.rs index d7183565b0..a8a475c47e 100644 --- a/crates/admin-cli/src/operating_system/create/args.rs +++ b/crates/admin-cli/src/operating_system/create/args.rs @@ -25,10 +25,10 @@ use crate::operating_system::common::parse_param; EXAMPLES: Create an OS definition: - $ carbide-admin-cli operating-system create --name ubuntu-22.04 --org fds34511233a + $ nico-admin-cli operating-system create --name ubuntu-22.04 --org fds34511233a Create one with a description, inactive, allowing parameter overrides: - $ carbide-admin-cli operating-system create --name ubuntu-22.04 --org fds34511233a \ + $ nico-admin-cli operating-system create --name ubuntu-22.04 --org fds34511233a \ --description \"Ubuntu 22.04 base\" --is-active false --allow-override ")] diff --git a/crates/admin-cli/src/operating_system/delete/args.rs b/crates/admin-cli/src/operating_system/delete/args.rs index 78d3458d8d..565c44be82 100644 --- a/crates/admin-cli/src/operating_system/delete/args.rs +++ b/crates/admin-cli/src/operating_system/delete/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Delete an operating system definition by ID: - $ carbide-admin-cli operating-system delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli operating-system delete 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/operating_system/get_artifacts/args.rs b/crates/admin-cli/src/operating_system/get_artifacts/args.rs index 7ce3c9725d..149e1a0aa2 100644 --- a/crates/admin-cli/src/operating_system/get_artifacts/args.rs +++ b/crates/admin-cli/src/operating_system/get_artifacts/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Get the artifact list for an OS definition: - $ carbide-admin-cli operating-system get-artifacts 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli operating-system get-artifacts 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/operating_system/set_cached_url/args.rs b/crates/admin-cli/src/operating_system/set_cached_url/args.rs index 87ab7875ad..5670438dc3 100644 --- a/crates/admin-cli/src/operating_system/set_cached_url/args.rs +++ b/crates/admin-cli/src/operating_system/set_cached_url/args.rs @@ -38,11 +38,11 @@ fn parse_cached_url_update(s: &str) -> Result diff --git a/crates/admin-cli/src/os_image/delete/args.rs b/crates/admin-cli/src/os_image/delete/args.rs index b8004f16ed..dfd3222a62 100644 --- a/crates/admin-cli/src/os_image/delete/args.rs +++ b/crates/admin-cli/src/os_image/delete/args.rs @@ -26,7 +26,7 @@ use crate::os_image::common::str_to_rpc_uuid; EXAMPLES: Delete an OS image (must be unused by any instance): - $ carbide-admin-cli os-image delete --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli os-image delete --id 12345678-1234-5678-90ab-cdef01234567 \ --tenant-org-id fds34511233a ")] diff --git a/crates/admin-cli/src/os_image/show/args.rs b/crates/admin-cli/src/os_image/show/args.rs index 06ee588f3b..8e6fd3fc08 100644 --- a/crates/admin-cli/src/os_image/show/args.rs +++ b/crates/admin-cli/src/os_image/show/args.rs @@ -25,13 +25,13 @@ use crate::os_image::common::str_to_rpc_uuid; EXAMPLES: Show a single OS image by UUID: - $ carbide-admin-cli os-image show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli os-image show --id 12345678-1234-5678-90ab-cdef01234567 List all OS images for a tenant: - $ carbide-admin-cli os-image show --tenant-org-id fds34511233a + $ nico-admin-cli os-image show --tenant-org-id fds34511233a List every OS image: - $ carbide-admin-cli os-image show + $ nico-admin-cli os-image show ")] pub struct Args { diff --git a/crates/admin-cli/src/os_image/update/args.rs b/crates/admin-cli/src/os_image/update/args.rs index 37cccc2ab5..e5a4032a10 100644 --- a/crates/admin-cli/src/os_image/update/args.rs +++ b/crates/admin-cli/src/os_image/update/args.rs @@ -25,11 +25,11 @@ use crate::os_image::common::str_to_rpc_uuid; EXAMPLES: Rename an OS image and update its description: - $ carbide-admin-cli os-image update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli os-image update --id 12345678-1234-5678-90ab-cdef01234567 \ --name ubuntu-22.04 --description \"Ubuntu 22.04 base\" Rotate the image URL's auth token: - $ carbide-admin-cli os-image update --id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli os-image update --id 12345678-1234-5678-90ab-cdef01234567 \ --auth-type Bearer --auth-token ")] diff --git a/crates/admin-cli/src/ping/args.rs b/crates/admin-cli/src/ping/args.rs index de2c8162e5..77eb957c3e 100644 --- a/crates/admin-cli/src/ping/args.rs +++ b/crates/admin-cli/src/ping/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Ping the API server (default 1s interval): - $ carbide-admin-cli ping + $ nico-admin-cli ping Ping twice a second: - $ carbide-admin-cli ping --interval 0.5 + $ nico-admin-cli ping --interval 0.5 ")] pub struct Opts { diff --git a/crates/admin-cli/src/power_shelf/delete/args.rs b/crates/admin-cli/src/power_shelf/delete/args.rs index 495e4cb759..b3afc274b1 100644 --- a/crates/admin-cli/src/power_shelf/delete/args.rs +++ b/crates/admin-cli/src/power_shelf/delete/args.rs @@ -25,7 +25,7 @@ use clap::Parser; EXAMPLES: Delete a power shelf by ID: - $ carbide-admin-cli power-shelf delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf delete 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/power_shelf/force_delete/args.rs b/crates/admin-cli/src/power_shelf/force_delete/args.rs index cee0b9e8cd..c9cd50a8fd 100644 --- a/crates/admin-cli/src/power_shelf/force_delete/args.rs +++ b/crates/admin-cli/src/power_shelf/force_delete/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Force delete a power shelf: - $ carbide-admin-cli power-shelf force-delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf force-delete 12345678-1234-5678-90ab-cdef01234567 Force delete a power shelf and its machine interfaces: - $ carbide-admin-cli power-shelf force-delete 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces + $ nico-admin-cli power-shelf force-delete 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces ")] pub struct Args { diff --git a/crates/admin-cli/src/power_shelf/health_report/add/args.rs b/crates/admin-cli/src/power_shelf/health_report/add/args.rs index bff79823f2..2c8ae7b1a8 100644 --- a/crates/admin-cli/src/power_shelf/health_report/add/args.rs +++ b/crates/admin-cli/src/power_shelf/health_report/add/args.rs @@ -26,15 +26,15 @@ use crate::machine::HealthReportTemplates; EXAMPLES: Add a health report source from a predefined template: - $ carbide-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance --message \"Firmware upgrade in progress\" Add a health report source from raw JSON: - $ carbide-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 \ --health-report '{...}' Preview the report without sending it: - $ carbide-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template degraded --print-only ")] diff --git a/crates/admin-cli/src/power_shelf/health_report/remove/args.rs b/crates/admin-cli/src/power_shelf/health_report/remove/args.rs index 574e179d61..6fbac79096 100644 --- a/crates/admin-cli/src/power_shelf/health_report/remove/args.rs +++ b/crates/admin-cli/src/power_shelf/health_report/remove/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Remove a health report source from a power shelf (source name from `health-report show`): - $ carbide-admin-cli power-shelf health-report remove 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf health-report remove 12345678-1234-5678-90ab-cdef01234567 \ internal-maintenance ")] diff --git a/crates/admin-cli/src/power_shelf/health_report/show/args.rs b/crates/admin-cli/src/power_shelf/health_report/show/args.rs index 7b612f53a5..6afe22966d 100644 --- a/crates/admin-cli/src/power_shelf/health_report/show/args.rs +++ b/crates/admin-cli/src/power_shelf/health_report/show/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: List the health report sources for a power shelf: - $ carbide-admin-cli power-shelf health-report show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf health-report show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/power_shelf/list/args.rs b/crates/admin-cli/src/power_shelf/list/args.rs index 8ffb4d2bea..626ba89bd3 100644 --- a/crates/admin-cli/src/power_shelf/list/args.rs +++ b/crates/admin-cli/src/power_shelf/list/args.rs @@ -24,16 +24,16 @@ use rpc::forge::DeletedFilter; EXAMPLES: List all live power shelves: - $ carbide-admin-cli power-shelf list + $ nico-admin-cli power-shelf list Include deleted power shelves: - $ carbide-admin-cli power-shelf list --deleted include + $ nico-admin-cli power-shelf list --deleted include Filter by controller state: - $ carbide-admin-cli power-shelf list --controller-state ready + $ nico-admin-cli power-shelf list --controller-state ready Find a power shelf by its BMC MAC address: - $ carbide-admin-cli power-shelf list --bmc-mac 00:11:22:33:44:55 + $ nico-admin-cli power-shelf list --bmc-mac 00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/power_shelf/maintenance/args.rs b/crates/admin-cli/src/power_shelf/maintenance/args.rs index 0a17efc12e..956ff8ba38 100644 --- a/crates/admin-cli/src/power_shelf/maintenance/args.rs +++ b/crates/admin-cli/src/power_shelf/maintenance/args.rs @@ -30,10 +30,10 @@ pub enum Args { EXAMPLES: Power on a power shelf: - $ carbide-admin-cli power-shelf maintenance power-on --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf maintenance power-on --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 Power on several at once, citing a reference ticket: - $ carbide-admin-cli power-shelf maintenance power-on \ + $ nico-admin-cli power-shelf maintenance power-on \ --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 \ --reference https://tickets.example.com/PS-42 @@ -44,10 +44,10 @@ Power on several at once, citing a reference ticket: EXAMPLES: Power off a power shelf: - $ carbide-admin-cli power-shelf maintenance power-off --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf maintenance power-off --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 Power off several at once, citing a reference ticket: - $ carbide-admin-cli power-shelf maintenance power-off \ + $ nico-admin-cli power-shelf maintenance power-off \ --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 \ --reference https://tickets.example.com/PS-42 diff --git a/crates/admin-cli/src/power_shelf/metadata/args.rs b/crates/admin-cli/src/power_shelf/metadata/args.rs index 5400ee1d12..a1df8c942e 100644 --- a/crates/admin-cli/src/power_shelf/metadata/args.rs +++ b/crates/admin-cli/src/power_shelf/metadata/args.rs @@ -37,7 +37,7 @@ pub enum Args { EXAMPLES: Show a power shelf's metadata: - $ carbide-admin-cli power-shelf metadata show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf metadata show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct PowerShelfMetadataCommandShow { @@ -50,7 +50,7 @@ pub struct PowerShelfMetadataCommandShow { EXAMPLES: Set a power shelf's name and description: - $ carbide-admin-cli power-shelf metadata set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf metadata set 12345678-1234-5678-90ab-cdef01234567 \ --name ps-01 --description \"Rack 4 power shelf\" ")] @@ -68,10 +68,10 @@ pub struct PowerShelfMetadataCommandSet { EXAMPLES: Add a key-only label: - $ carbide-admin-cli power-shelf metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge + $ nico-admin-cli power-shelf metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge Add a key/value label: - $ carbide-admin-cli power-shelf metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ --key row --value C ")] @@ -89,7 +89,7 @@ pub struct PowerShelfMetadataCommandAddLabel { EXAMPLES: Remove one or more labels by key: - $ carbide-admin-cli power-shelf metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ --keys row --keys edge ")] @@ -105,10 +105,10 @@ pub struct PowerShelfMetadataCommandRemoveLabels { EXAMPLES: Fill in missing metadata from the expected-power-shelf (leaving existing values intact): - $ carbide-admin-cli power-shelf metadata from-expected-power-shelf 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf metadata from-expected-power-shelf 12345678-1234-5678-90ab-cdef01234567 Overwrite the power shelf's metadata with the expected-power-shelf's values: - $ carbide-admin-cli power-shelf metadata from-expected-power-shelf 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli power-shelf metadata from-expected-power-shelf 12345678-1234-5678-90ab-cdef01234567 \ --replace-all ")] diff --git a/crates/admin-cli/src/power_shelf/show/args.rs b/crates/admin-cli/src/power_shelf/show/args.rs index 83f557c1fd..fdb574d2e6 100644 --- a/crates/admin-cli/src/power_shelf/show/args.rs +++ b/crates/admin-cli/src/power_shelf/show/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: List all power shelves: - $ carbide-admin-cli power-shelf show + $ nico-admin-cli power-shelf show Show one power shelf by ID or name: - $ carbide-admin-cli power-shelf show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli power-shelf show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/rack/delete/args.rs b/crates/admin-cli/src/rack/delete/args.rs index b0f1f86f4c..be3c935f4a 100644 --- a/crates/admin-cli/src/rack/delete/args.rs +++ b/crates/admin-cli/src/rack/delete/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Delete a rack by ID: - $ carbide-admin-cli rack delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli rack delete 12345678-1234-5678-90ab-cdef01234567 Delete a rack by name: - $ carbide-admin-cli rack delete rack-01 + $ nico-admin-cli rack delete rack-01 ")] pub struct Args { diff --git a/crates/admin-cli/src/rack/list/args.rs b/crates/admin-cli/src/rack/list/args.rs index 6c8d7f0dbf..96966c2a11 100644 --- a/crates/admin-cli/src/rack/list/args.rs +++ b/crates/admin-cli/src/rack/list/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: List all racks: - $ carbide-admin-cli rack list + $ nico-admin-cli rack list ")] pub struct Args; diff --git a/crates/admin-cli/src/rack/maintenance/args.rs b/crates/admin-cli/src/rack/maintenance/args.rs index 5060cbb9c1..6556922299 100644 --- a/crates/admin-cli/src/rack/maintenance/args.rs +++ b/crates/admin-cli/src/rack/maintenance/args.rs @@ -31,14 +31,14 @@ pub enum Args { EXAMPLES: Start maintenance on a full rack (all activities, all components): - $ carbide-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 Run only a firmware upgrade on specific machines: - $ carbide-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 \ --machine-ids m1,m2 --activities firmware-upgrade Firmware upgrade from a SOT JSON file, forcing the update: - $ carbide-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 \ --activities firmware-upgrade --sot-json-file ./sot.json --access-token \"$TOKEN\" --force-update ")] diff --git a/crates/admin-cli/src/rack/metadata/args.rs b/crates/admin-cli/src/rack/metadata/args.rs index 45c96d6cba..97f6e8eb4a 100644 --- a/crates/admin-cli/src/rack/metadata/args.rs +++ b/crates/admin-cli/src/rack/metadata/args.rs @@ -37,7 +37,7 @@ pub enum Args { EXAMPLES: Show a rack's metadata: - $ carbide-admin-cli rack metadata show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli rack metadata show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct RackMetadataCommandShow { @@ -50,7 +50,7 @@ pub struct RackMetadataCommandShow { EXAMPLES: Set a rack's name and description: - $ carbide-admin-cli rack metadata set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli rack metadata set 12345678-1234-5678-90ab-cdef01234567 \ --name rack-01 --description \"Row C, position 1\" ")] @@ -68,10 +68,10 @@ pub struct RackMetadataCommandSet { EXAMPLES: Add a key-only label: - $ carbide-admin-cli rack metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge + $ nico-admin-cli rack metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge Add a key/value label: - $ carbide-admin-cli rack metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli rack metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ --key row --value C ")] @@ -89,7 +89,7 @@ pub struct RackMetadataCommandAddLabel { EXAMPLES: Remove one or more labels by key: - $ carbide-admin-cli rack metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli rack metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ --keys row --keys edge ")] @@ -105,10 +105,10 @@ pub struct RackMetadataCommandRemoveLabels { EXAMPLES: Fill in missing metadata from the expected-rack (leaving existing values intact): - $ carbide-admin-cli rack metadata from-expected-rack 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli rack metadata from-expected-rack 12345678-1234-5678-90ab-cdef01234567 Overwrite the rack's metadata with the expected-rack's values: - $ carbide-admin-cli rack metadata from-expected-rack 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli rack metadata from-expected-rack 12345678-1234-5678-90ab-cdef01234567 \ --replace-all ")] diff --git a/crates/admin-cli/src/rack/profile/show/args.rs b/crates/admin-cli/src/rack/profile/show/args.rs index cfbffc9c82..5fc7cb9532 100644 --- a/crates/admin-cli/src/rack/profile/show/args.rs +++ b/crates/admin-cli/src/rack/profile/show/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Show the profile for a rack: - $ carbide-admin-cli rack profile show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli rack profile show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/rack/show/args.rs b/crates/admin-cli/src/rack/show/args.rs index e5dad1eab6..ab37d1f9ff 100644 --- a/crates/admin-cli/src/rack/show/args.rs +++ b/crates/admin-cli/src/rack/show/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: List all racks: - $ carbide-admin-cli rack show + $ nico-admin-cli rack show Show details for one rack: - $ carbide-admin-cli rack show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli rack show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/redfish/args.rs b/crates/admin-cli/src/redfish/args.rs index 8ff14b1ef2..5b6d18bec9 100644 --- a/crates/admin-cli/src/redfish/args.rs +++ b/crates/admin-cli/src/redfish/args.rs @@ -28,25 +28,21 @@ Every redfish command targets a BMC: --address is required, --username and --password are optional, and all are given before the subcommand: Read the current power state: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-power-state + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-power-state Power a machine on: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword on + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword on Force a machine off (alias: off): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-off + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-off Set PXE first in the boot order: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword boot-pxe + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword boot-pxe Update host firmware from a local package: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ update-firmware-multipart --filename ./host-fw.bin -Browse an arbitrary Redfish URI: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ - browse --uri /redfish/v1/Systems - ")] pub struct RedfishAction { #[clap(subcommand)] @@ -113,7 +109,7 @@ pub enum Cmd { EXAMPLES: Force a machine off (also accepted as the alias `off`): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-off + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-off ")] ForceOff, @@ -125,7 +121,7 @@ Force a machine off (also accepted as the alias `off`): EXAMPLES: Force-restart a machine (also accepted as the alias `reset`): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-restart + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-restart ")] ForceRestart, @@ -137,7 +133,7 @@ Force-restart a machine (also accepted as the alias `reset`): EXAMPLES: Gracefully restart a machine (also accepted as the alias `restart`): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword graceful-restart + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword graceful-restart ")] GracefulRestart, @@ -147,7 +143,7 @@ Gracefully restart a machine (also accepted as the alias `restart`): EXAMPLES: Gracefully shut a machine down (also accepted as the alias `shutdown`): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword graceful-shutdown + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword graceful-shutdown ")] GracefulShutdown, @@ -198,7 +194,7 @@ Gracefully shut a machine down (also accepted as the alias `shutdown`): EXAMPLES: Change the UEFI password (supply the current and new values): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ change-uefi-password --current-password mycurrentpassword --new-password mynewpassword ")] @@ -218,7 +214,7 @@ Change the UEFI password (supply the current and new values): EXAMPLES: Clear the UEFI password (supply the current one): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ clear-uefi-password --current-password mycurrentpassword --new-password '' ")] @@ -241,8 +237,9 @@ Clear the UEFI password (supply the current one): IsInfiniteBootEnabled, /// Enable infinite boot EnableInfiniteBoot, - /// Set DPU NIC mode - #[clap(visible_alias = "set-nic-mode")] + /// Set NIC mode (host networking via the NIC) + SetNicMode, + /// Set DPU mode (host networking via the DPU) SetDpuMode, /// Power cycle a machine ChassisResetCard1Powercycle, @@ -252,7 +249,7 @@ Clear the UEFI password (supply the current one): EXAMPLES: Set the boot order so the DPU boots first: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ set-boot-order-dpu-first --boot-interface-mac 00:11:22:33:44:55 ")] @@ -275,7 +272,7 @@ Set the boot order so the DPU boots first: EXAMPLES: Check whether the DPU-first boot order is already configured: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ is-boot-order-setup --boot-interface-mac 00:11:22:33:44:55 ")] @@ -288,11 +285,11 @@ Check whether the DPU-first boot order is already configured: EXAMPLES: List all BIOS boot options: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ get-boot-option --all Show one boot option by ID: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ get-boot-option --id Boot0001 ")] @@ -308,11 +305,11 @@ pub struct BootOptionSelector { EXAMPLES: Show DPU firmware versions: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware show --all Show DPU port information: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu ports ")] @@ -329,15 +326,15 @@ pub enum DpuOperations { EXAMPLES: Print the DPU firmware update status: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware status Update the DPU BMC firmware from a package: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware update --package ./bmc-fw.fwpkg Show all discovered firmware versions: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware show --all ")] @@ -355,7 +352,7 @@ pub enum FwCommand { EXAMPLES: Install a DPU BMC firmware package: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware update --package ./bmc-fw.fwpkg ")] @@ -377,7 +374,7 @@ pub struct UefiPassword { EXAMPLES: Rename a BMC account: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ change-bmc-username --old-user svc-ops --new-user svc-platform ")] @@ -393,7 +390,7 @@ pub struct BmcUsername { EXAMPLES: Change a BMC user's password: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ change-bmc-password --user svc-ops --new-password 'mynewpassword' ")] @@ -409,11 +406,11 @@ pub struct BmcPassword { EXAMPLES: Update host firmware from a local file: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ update-firmware-multipart --filename ./host-fw.bin Update firmware and specify the component type: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ update-firmware-multipart --filename ./uefi.bin --component-type uefi ")] @@ -432,7 +429,7 @@ pub struct Multipart { EXAMPLES: Get details for a Redfish task: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ get-task --taskid JID_123456789012 ")] @@ -446,7 +443,7 @@ pub struct Task { EXAMPLES: Show one chassis subsystem by ID: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ get-chassis --chassis-id Chassis-1 ")] @@ -460,11 +457,11 @@ pub struct Chassis { EXAMPLES: Create a BMC user (defaults to the administrator role): - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ create-bmc-user --user svc-ops --new-password 'mynewpassword' Create a read-only BMC user: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ create-bmc-user --user auditor --new-password 'mynewpassword' --role-id readonly ")] @@ -486,7 +483,7 @@ pub struct BmcUser { EXAMPLES: Delete a BMC user by name: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ delete-bmc-user --user svc-ops ")] @@ -500,7 +497,7 @@ pub struct DeleteBmcUser { EXAMPLES: Run the standard machine setup: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ machine-setup --boot-interface-mac 00:11:22:33:44:55 ")] @@ -518,7 +515,7 @@ pub struct MachineSetupArgs { EXAMPLES: Check what machine-setup steps remain: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ machine-setup-status --boot-interface-mac 00:11:22:33:44:55 ")] @@ -538,8 +535,8 @@ pub struct SetBootOrderDpuFirstArgs { EXAMPLES: Decommission a storage controller: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ - decomission-controller --controller-id RAID.Slot.1-1 + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + decommission-controller --controller-id RAID.Slot.1-1 ")] pub struct DecomissionControllerArgs { @@ -552,7 +549,7 @@ pub struct DecomissionControllerArgs { EXAMPLES: Create a volume on a storage controller: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ create-volume --controller-id RAID.Slot.1-1 --volume-name data0 ")] @@ -572,15 +569,15 @@ pub struct CreateVolumeArgs { EXAMPLES: Show all discovered firmware key/values: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware show --all Show just the DPU OS version: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware show --dpu-os Show a specific firmware type by name: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu firmware show DPU_NIC ")] @@ -625,11 +622,11 @@ pub struct ShowFw { EXAMPLES: Show all DPU ports: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu ports Show a single port by name: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ dpu ports eth0 ")] @@ -655,7 +652,7 @@ pub struct ShowPort { EXAMPLES: Set one or more BIOS attributes from JSON: - $ carbide-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ + $ nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword \ set-bios --attributes '{\"OperatingModes_ChooseOperatingMode\": \"MaximumPerformance\"}' ")] diff --git a/crates/admin-cli/src/redfish/cmds.rs b/crates/admin-cli/src/redfish/cmds.rs index 434c494661..b030907b53 100644 --- a/crates/admin-cli/src/redfish/cmds.rs +++ b/crates/admin-cli/src/redfish/cmds.rs @@ -492,6 +492,9 @@ pub async fn action(action: RedfishAction) -> color_eyre::Result<()> { redfish.enable_infinite_boot().await?; println!("BIOS changes require a system restart to take effect."); } + SetNicMode => { + redfish.set_nic_mode(NicMode::Nic).await?; + } SetDpuMode => { redfish.set_nic_mode(NicMode::Dpu).await?; } diff --git a/crates/admin-cli/src/resource_pool/grow/args.rs b/crates/admin-cli/src/resource_pool/grow/args.rs index e3248f4dc4..7ada13c480 100644 --- a/crates/admin-cli/src/resource_pool/grow/args.rs +++ b/crates/admin-cli/src/resource_pool/grow/args.rs @@ -26,7 +26,7 @@ use clap::{ArgGroup, Parser}; EXAMPLES: Add capacity to resource pools from a TOML file: - $ carbide-admin-cli resource-pool grow --filename ./grow-pools.toml + $ nico-admin-cli resource-pool grow --filename ./grow-pools.toml ")] pub struct Args { diff --git a/crates/admin-cli/src/resource_pool/list/args.rs b/crates/admin-cli/src/resource_pool/list/args.rs index e4cef300ef..efad1b6ee9 100644 --- a/crates/admin-cli/src/resource_pool/list/args.rs +++ b/crates/admin-cli/src/resource_pool/list/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: List all resource pools with their stats: - $ carbide-admin-cli resource-pool list + $ nico-admin-cli resource-pool list ")] pub struct Args; diff --git a/crates/admin-cli/src/rms/args.rs b/crates/admin-cli/src/rms/args.rs index 6fb1d91c7e..87a52d1e1d 100644 --- a/crates/admin-cli/src/rms/args.rs +++ b/crates/admin-cli/src/rms/args.rs @@ -22,13 +22,13 @@ use clap::Parser; EXAMPLES: Get the full RMS inventory (RMS URL taken from --url or config): - $ carbide-admin-cli rms --url https://rms.example.com:8443 inventory + $ nico-admin-cli rms --url https://rms.example.com:8443 inventory Get a rack's power-on sequence (URL from config): - $ carbide-admin-cli rms power-on-sequence rack-1 + $ nico-admin-cli rms power-on-sequence rack-1 Talk to RMS over mTLS with explicit certs: - $ carbide-admin-cli rms --url https://rms.example.com:8443 \ + $ nico-admin-cli rms --url https://rms.example.com:8443 \ --root-ca /etc/rms/ca.crt --client-cert /etc/rms/client.crt \ --client-key /etc/rms/client.key inventory @@ -71,7 +71,7 @@ pub enum Cmd { EXAMPLES: Get the power-on sequence for a rack: - $ carbide-admin-cli rms power-on-sequence rack-1 + $ nico-admin-cli rms power-on-sequence rack-1 ")] pub struct PowerOnSequence { @@ -92,7 +92,7 @@ impl From for librms::protos::rack_manager::GetRackPowerOnSeque EXAMPLES: Get the power state of a node in a rack: - $ carbide-admin-cli rms power-state rack-1 node-1 + $ nico-admin-cli rms power-state rack-1 node-1 ")] pub struct PowerState { @@ -116,7 +116,7 @@ impl From for librms::protos::rack_manager::GetPowerStateRequest { EXAMPLES: Get the firmware inventory for a node in a rack: - $ carbide-admin-cli rms firmware-inventory rack-1 node-1 + $ nico-admin-cli rms firmware-inventory rack-1 node-1 ")] pub struct FirmwareInventory { diff --git a/crates/admin-cli/src/route_server/add/args.rs b/crates/admin-cli/src/route_server/add/args.rs index bdb6d3cc6d..99b3390ca3 100644 --- a/crates/admin-cli/src/route_server/add/args.rs +++ b/crates/admin-cli/src/route_server/add/args.rs @@ -27,10 +27,10 @@ use crate::route_server::common::AddressArgs; EXAMPLES: Add one or more route server addresses: - $ carbide-admin-cli route-server add 10.0.0.1,10.0.0.2 + $ nico-admin-cli route-server add 10.0.0.1,10.0.0.2 Add ephemerally against config-file entries (break-glass): - $ carbide-admin-cli route-server add 10.0.0.1 --source-type config_file + $ nico-admin-cli route-server add 10.0.0.1 --source-type config_file ")] pub struct Args { diff --git a/crates/admin-cli/src/route_server/get/args.rs b/crates/admin-cli/src/route_server/get/args.rs index d40979d68a..24c46fd732 100644 --- a/crates/admin-cli/src/route_server/get/args.rs +++ b/crates/admin-cli/src/route_server/get/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: List all configured route servers: - $ carbide-admin-cli route-server get + $ nico-admin-cli route-server get ")] pub struct Args {} diff --git a/crates/admin-cli/src/route_server/remove/args.rs b/crates/admin-cli/src/route_server/remove/args.rs index 5761256c3d..853c7d9964 100644 --- a/crates/admin-cli/src/route_server/remove/args.rs +++ b/crates/admin-cli/src/route_server/remove/args.rs @@ -27,10 +27,10 @@ use crate::route_server::common::AddressArgs; EXAMPLES: Remove one or more route server addresses: - $ carbide-admin-cli route-server remove 10.0.0.1,10.0.0.2 + $ nico-admin-cli route-server remove 10.0.0.1,10.0.0.2 Remove ephemerally against config-file entries (break-glass): - $ carbide-admin-cli route-server remove 10.0.0.1 --source-type config_file + $ nico-admin-cli route-server remove 10.0.0.1 --source-type config_file ")] pub struct Args { diff --git a/crates/admin-cli/src/route_server/replace/args.rs b/crates/admin-cli/src/route_server/replace/args.rs index be4ebb56ce..0ea59102ff 100644 --- a/crates/admin-cli/src/route_server/replace/args.rs +++ b/crates/admin-cli/src/route_server/replace/args.rs @@ -27,7 +27,7 @@ use crate::route_server::common::AddressArgs; EXAMPLES: Replace the entire route server list with a new set: - $ carbide-admin-cli route-server replace 10.0.0.1,10.0.0.2,10.0.0.3 + $ nico-admin-cli route-server replace 10.0.0.1,10.0.0.2,10.0.0.3 ")] pub struct Args { diff --git a/crates/admin-cli/src/rpc.rs b/crates/admin-cli/src/rpc.rs index 631eb80725..464bc96040 100644 --- a/crates/admin-cli/src/rpc.rs +++ b/crates/admin-cli/src/rpc.rs @@ -1675,7 +1675,7 @@ impl ApiClient { machine_id: MachineId, tags: Option>, allowed_tests: Option>, - run_unverfied_tests: bool, + run_unverified_tests: bool, contexts: Option>, ) -> CarbideCliResult { let allowed_tests: Vec = allowed_tests @@ -1688,7 +1688,7 @@ impl ApiClient { tags: tags.unwrap_or_default(), allowed_tests, action: rpc::machine_validation_on_demand_request::Action::Start.into(), - run_unverfied_tests, + run_unverfied_tests: run_unverified_tests, contexts: contexts.unwrap_or_default(), }; Ok(self.0.on_demand_machine_validation(request).await?) diff --git a/crates/admin-cli/src/scout_stream/mod.rs b/crates/admin-cli/src/scout_stream/mod.rs index 8bd0345863..f92890d9c7 100644 --- a/crates/admin-cli/src/scout_stream/mod.rs +++ b/crates/admin-cli/src/scout_stream/mod.rs @@ -47,7 +47,7 @@ pub enum ScoutStreamAction { EXAMPLES: Show all active scout stream connections: - $ carbide-admin-cli scout-stream show + $ nico-admin-cli scout-stream show ")] pub struct ConnectionsShowCommand {} @@ -58,7 +58,7 @@ pub struct ConnectionsShowCommand {} EXAMPLES: Disconnect a machine's scout stream connection: - $ carbide-admin-cli scout-stream disconnect 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli scout-stream disconnect 12345678-1234-5678-90ab-cdef01234567 ")] pub struct ConnectionsDisconnectCommand { @@ -71,7 +71,7 @@ pub struct ConnectionsDisconnectCommand { EXAMPLES: Ping-test a machine's scout stream connection: - $ carbide-admin-cli scout-stream ping 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli scout-stream ping 12345678-1234-5678-90ab-cdef01234567 ")] pub struct ConnectionsPingCommand { diff --git a/crates/admin-cli/src/set/bmc_proxy/args.rs b/crates/admin-cli/src/set/bmc_proxy/args.rs index d5d9f14299..1ee580ffe6 100644 --- a/crates/admin-cli/src/set/bmc_proxy/args.rs +++ b/crates/admin-cli/src/set/bmc_proxy/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Enable the BMC proxy and point it at a host:port: - $ carbide-admin-cli set bmc-proxy --enabled true --proxy 192.0.2.10:8080 + $ nico-admin-cli set bmc-proxy --enabled true --proxy 192.0.2.10:8080 Disable the BMC proxy: - $ carbide-admin-cli set bmc-proxy --enabled false + $ nico-admin-cli set bmc-proxy --enabled false ")] pub struct Args { diff --git a/crates/admin-cli/src/set/create_machines/args.rs b/crates/admin-cli/src/set/create_machines/args.rs index f6174ee79f..4b21450c65 100644 --- a/crates/admin-cli/src/set/create_machines/args.rs +++ b/crates/admin-cli/src/set/create_machines/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Enable automatic machine creation: - $ carbide-admin-cli set create-machines --enable + $ nico-admin-cli set create-machines --enable Disable automatic machine creation: - $ carbide-admin-cli set create-machines --disable + $ nico-admin-cli set create-machines --disable ")] pub struct Args { diff --git a/crates/admin-cli/src/set/log_filter/args.rs b/crates/admin-cli/src/set/log_filter/args.rs index ebe1cb4960..6d8a97365c 100644 --- a/crates/admin-cli/src/set/log_filter/args.rs +++ b/crates/admin-cli/src/set/log_filter/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Raise the server's log level, reverting after the default 1h: - $ carbide-admin-cli set log-filter --filter debug + $ nico-admin-cli set log-filter --filter debug Set a targeted filter that reverts after 30 minutes: - $ carbide-admin-cli set log-filter --filter carbide_api=trace,info --expiry 30min + $ nico-admin-cli set log-filter --filter carbide_api=trace,info --expiry 30min ")] pub struct Args { diff --git a/crates/admin-cli/src/set/site_explorer_enabled/args.rs b/crates/admin-cli/src/set/site_explorer_enabled/args.rs index 201cb3dd3f..16bd8b58bc 100644 --- a/crates/admin-cli/src/set/site_explorer_enabled/args.rs +++ b/crates/admin-cli/src/set/site_explorer_enabled/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Enable site-explorer: - $ carbide-admin-cli set site-explorer --enable + $ nico-admin-cli set site-explorer --enable Disable site-explorer: - $ carbide-admin-cli set site-explorer --disable + $ nico-admin-cli set site-explorer --disable ")] pub struct Args { diff --git a/crates/admin-cli/src/set/tracing_enabled/args.rs b/crates/admin-cli/src/set/tracing_enabled/args.rs index 04db5255f5..ab35742e8b 100644 --- a/crates/admin-cli/src/set/tracing_enabled/args.rs +++ b/crates/admin-cli/src/set/tracing_enabled/args.rs @@ -23,10 +23,10 @@ use clap::builder::BoolishValueParser; EXAMPLES: Enable OTLP trace/span export: - $ carbide-admin-cli set tracing-enabled true + $ nico-admin-cli set tracing-enabled true Disable OTLP trace/span export: - $ carbide-admin-cli set tracing-enabled false + $ nico-admin-cli set tracing-enabled false ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/clear_error/args.rs b/crates/admin-cli/src/site_explorer/clear_error/args.rs index a3f6aa8704..d41d153e2f 100644 --- a/crates/admin-cli/src/site_explorer/clear_error/args.rs +++ b/crates/admin-cli/src/site_explorer/clear_error/args.rs @@ -27,7 +27,7 @@ use super::super::common::ExploreOptions; EXAMPLES: Clear the last known error for a BMC in the latest report: - $ carbide-admin-cli site-explorer clear-error 192.0.2.10 + $ nico-admin-cli site-explorer clear-error 192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/copy_bfb_to_dpu_rshim/args.rs b/crates/admin-cli/src/site_explorer/copy_bfb_to_dpu_rshim/args.rs index d70ec20da1..451f9bd36f 100644 --- a/crates/admin-cli/src/site_explorer/copy_bfb_to_dpu_rshim/args.rs +++ b/crates/admin-cli/src/site_explorer/copy_bfb_to_dpu_rshim/args.rs @@ -23,11 +23,11 @@ use mac_address::MacAddress; EXAMPLES: Copy a BFB to a DPU's rshim via its BMC, power-cycling the host afterward: - $ carbide-admin-cli site-explorer copy-bfb-to-dpu-rshim 192.0.2.10 \ + $ nico-admin-cli site-explorer copy-bfb-to-dpu-rshim 192.0.2.10 \ --host-bmc-ip 192.0.2.20 Power-cycle the host first to release rshim control to the DPU BMC: - $ carbide-admin-cli site-explorer copy-bfb-to-dpu-rshim 192.0.2.10 \ + $ nico-admin-cli site-explorer copy-bfb-to-dpu-rshim 192.0.2.10 \ --host-bmc-ip 192.0.2.20 --pre-copy-powercycle ")] diff --git a/crates/admin-cli/src/site_explorer/delete/args.rs b/crates/admin-cli/src/site_explorer/delete/args.rs index 72f8d8a1a2..a930ae0df7 100644 --- a/crates/admin-cli/src/site_explorer/delete/args.rs +++ b/crates/admin-cli/src/site_explorer/delete/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Delete an explored endpoint from the database: - $ carbide-admin-cli site-explorer delete --address 192.0.2.10 + $ nico-admin-cli site-explorer delete --address 192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/explore/args.rs b/crates/admin-cli/src/site_explorer/explore/args.rs index 959603d93d..2065f9bdf4 100644 --- a/crates/admin-cli/src/site_explorer/explore/args.rs +++ b/crates/admin-cli/src/site_explorer/explore/args.rs @@ -27,10 +27,10 @@ use super::super::common::ExploreOptions; EXAMPLES: Explore a single host now and print the report (not stored): - $ carbide-admin-cli site-explorer explore 192.0.2.10 + $ nico-admin-cli site-explorer explore 192.0.2.10 Explore a host, supplying the MAC it sent DHCP from: - $ carbide-admin-cli site-explorer explore 192.0.2.10 --mac 00:11:22:33:44:55 + $ nico-admin-cli site-explorer explore 192.0.2.10 --mac 00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/get_report/args.rs b/crates/admin-cli/src/site_explorer/get_report/args.rs index dbdf1771be..0009187f4f 100644 --- a/crates/admin-cli/src/site_explorer/get_report/args.rs +++ b/crates/admin-cli/src/site_explorer/get_report/args.rs @@ -22,13 +22,13 @@ use clap::{ArgGroup, Parser}; EXAMPLES: Dump the entire latest report as JSON: - $ carbide-admin-cli site-explorer get-report all + $ nico-admin-cli site-explorer get-report all Show discovered managed-host details: - $ carbide-admin-cli site-explorer get-report managed-host + $ nico-admin-cli site-explorer get-report managed-host Show explored endpoint details: - $ carbide-admin-cli site-explorer get-report endpoint + $ nico-admin-cli site-explorer get-report endpoint ")] pub enum Args { @@ -46,16 +46,16 @@ pub enum Args { EXAMPLES: List all explored endpoints: - $ carbide-admin-cli site-explorer get-report endpoint + $ nico-admin-cli site-explorer get-report endpoint Show one endpoint by BMC IP: - $ carbide-admin-cli site-explorer get-report endpoint 192.0.2.10 + $ nico-admin-cli site-explorer get-report endpoint 192.0.2.10 Show only endpoints that errored, filtered by vendor: - $ carbide-admin-cli site-explorer get-report endpoint --erroronly --vendor nvidia + $ nico-admin-cli site-explorer get-report endpoint --erroronly --vendor nvidia Show only endpoints not yet paired to a managed host: - $ carbide-admin-cli site-explorer get-report endpoint --unpairedonly + $ nico-admin-cli site-explorer get-report endpoint --unpairedonly ")] pub struct EndpointInfo { @@ -88,13 +88,13 @@ pub struct EndpointInfo { EXAMPLES: List all discovered managed hosts: - $ carbide-admin-cli site-explorer get-report managed-host + $ nico-admin-cli site-explorer get-report managed-host Show one managed host by its host/DPU BMC IP: - $ carbide-admin-cli site-explorer get-report managed-host 192.0.2.10 + $ nico-admin-cli site-explorer get-report managed-host 192.0.2.10 Filter managed hosts by vendor: - $ carbide-admin-cli site-explorer get-report managed-host --vendor nvidia + $ nico-admin-cli site-explorer get-report managed-host --vendor nvidia ")] pub struct ManagedHostInfo { diff --git a/crates/admin-cli/src/site_explorer/have_credentials/args.rs b/crates/admin-cli/src/site_explorer/have_credentials/args.rs index 76dcf81ea1..487af634ab 100644 --- a/crates/admin-cli/src/site_explorer/have_credentials/args.rs +++ b/crates/admin-cli/src/site_explorer/have_credentials/args.rs @@ -27,7 +27,7 @@ use super::super::common::ExploreOptions; EXAMPLES: Check whether carbide has working credentials for a BMC: - $ carbide-admin-cli site-explorer have-credentials 192.0.2.10 + $ nico-admin-cli site-explorer have-credentials 192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/is_bmc_in_managed_host/args.rs b/crates/admin-cli/src/site_explorer/is_bmc_in_managed_host/args.rs index 3c47abe0a6..3cf36d1666 100644 --- a/crates/admin-cli/src/site_explorer/is_bmc_in_managed_host/args.rs +++ b/crates/admin-cli/src/site_explorer/is_bmc_in_managed_host/args.rs @@ -27,7 +27,7 @@ use super::super::common::ExploreOptions; EXAMPLES: Check whether a BMC belongs to a discovered managed host: - $ carbide-admin-cli site-explorer is-bmc-in-managed-host 192.0.2.10 + $ nico-admin-cli site-explorer is-bmc-in-managed-host 192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/re_explore/args.rs b/crates/admin-cli/src/site_explorer/re_explore/args.rs index cf7fd494bc..4a0d83784f 100644 --- a/crates/admin-cli/src/site_explorer/re_explore/args.rs +++ b/crates/admin-cli/src/site_explorer/re_explore/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Queue a host for re-exploration in the next cycle (result is stored): - $ carbide-admin-cli site-explorer re-explore 192.0.2.10 + $ nico-admin-cli site-explorer re-explore 192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/refresh_endpoint/args.rs b/crates/admin-cli/src/site_explorer/refresh_endpoint/args.rs index dc49c0fc99..50da0fe814 100644 --- a/crates/admin-cli/src/site_explorer/refresh_endpoint/args.rs +++ b/crates/admin-cli/src/site_explorer/refresh_endpoint/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Immediately probe a BMC endpoint and persist the report: - $ carbide-admin-cli site-explorer refresh 192.0.2.10 + $ nico-admin-cli site-explorer refresh 192.0.2.10 ")] pub struct Args { diff --git a/crates/admin-cli/src/site_explorer/remediation/args.rs b/crates/admin-cli/src/site_explorer/remediation/args.rs index cfb61ce50e..e091c41fda 100644 --- a/crates/admin-cli/src/site_explorer/remediation/args.rs +++ b/crates/admin-cli/src/site_explorer/remediation/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Pause remediation actions for an endpoint: - $ carbide-admin-cli site-explorer remediation 192.0.2.10 --pause + $ nico-admin-cli site-explorer remediation 192.0.2.10 --pause Resume remediation actions for an endpoint: - $ carbide-admin-cli site-explorer remediation 192.0.2.10 --resume + $ nico-admin-cli site-explorer remediation 192.0.2.10 --resume ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/assign/args.rs b/crates/admin-cli/src/sku/assign/args.rs index 11508dc79c..6ca46b0b27 100644 --- a/crates/admin-cli/src/sku/assign/args.rs +++ b/crates/admin-cli/src/sku/assign/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Assign a SKU to a machine: - $ carbide-admin-cli sku assign DGX-H100-640GB 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli sku assign DGX-H100-640GB 12345678-1234-5678-90ab-cdef01234567 Force the assignment even if the machine does not verify against the SKU: - $ carbide-admin-cli sku assign DGX-H100-640GB 12345678-1234-5678-90ab-cdef01234567 --force + $ nico-admin-cli sku assign DGX-H100-640GB 12345678-1234-5678-90ab-cdef01234567 --force ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/bulk_update_metadata/args.rs b/crates/admin-cli/src/sku/bulk_update_metadata/args.rs index 8138896b8c..0be4b6c67a 100644 --- a/crates/admin-cli/src/sku/bulk_update_metadata/args.rs +++ b/crates/admin-cli/src/sku/bulk_update_metadata/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Update metadata for many SKUs from a CSV file: - $ carbide-admin-cli sku bulk-update-metadata ./sku-metadata.csv + $ nico-admin-cli sku bulk-update-metadata ./sku-metadata.csv ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/common.rs b/crates/admin-cli/src/sku/common.rs index 428137105c..6c8292dbb2 100644 --- a/crates/admin-cli/src/sku/common.rs +++ b/crates/admin-cli/src/sku/common.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: List all SKUs: - $ carbide-admin-cli sku show + $ nico-admin-cli sku show Show details for one SKU: - $ carbide-admin-cli sku show DGX-H100-640GB + $ nico-admin-cli sku show DGX-H100-640GB ")] pub struct ShowSkuOptions { @@ -38,10 +38,10 @@ pub struct ShowSkuOptions { EXAMPLES: Create SKUs from a file: - $ carbide-admin-cli sku create ./skus.json + $ nico-admin-cli sku create ./skus.json Create from a file but override the SKU ID: - $ carbide-admin-cli sku create ./skus.json --id DGX-H100-640GB + $ nico-admin-cli sku create ./skus.json --id DGX-H100-640GB ")] pub struct CreateSkuOptions { diff --git a/crates/admin-cli/src/sku/delete/args.rs b/crates/admin-cli/src/sku/delete/args.rs index d38965c281..3e4864c377 100644 --- a/crates/admin-cli/src/sku/delete/args.rs +++ b/crates/admin-cli/src/sku/delete/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Delete a SKU by ID: - $ carbide-admin-cli sku delete DGX-H100-640GB + $ nico-admin-cli sku delete DGX-H100-640GB ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/generate/args.rs b/crates/admin-cli/src/sku/generate/args.rs index 87e4b2b033..a2038e3cf4 100644 --- a/crates/admin-cli/src/sku/generate/args.rs +++ b/crates/admin-cli/src/sku/generate/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Generate SKU data from an existing machine: - $ carbide-admin-cli sku generate 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli sku generate 12345678-1234-5678-90ab-cdef01234567 Generate and override the resulting SKU ID: - $ carbide-admin-cli sku generate 12345678-1234-5678-90ab-cdef01234567 --id DGX-H100-640GB + $ nico-admin-cli sku generate 12345678-1234-5678-90ab-cdef01234567 --id DGX-H100-640GB ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/replace/args.rs b/crates/admin-cli/src/sku/replace/args.rs index b368a5123b..6dd8fbf247 100644 --- a/crates/admin-cli/src/sku/replace/args.rs +++ b/crates/admin-cli/src/sku/replace/args.rs @@ -27,7 +27,7 @@ use super::super::common::CreateSkuOptions; EXAMPLES: Replace a SKU's component list from a file: - $ carbide-admin-cli sku replace ./skus.json --id DGX-H100-640GB + $ nico-admin-cli sku replace ./skus.json --id DGX-H100-640GB ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/show_machines/args.rs b/crates/admin-cli/src/sku/show_machines/args.rs index 4831cff674..012a21c808 100644 --- a/crates/admin-cli/src/sku/show_machines/args.rs +++ b/crates/admin-cli/src/sku/show_machines/args.rs @@ -27,7 +27,7 @@ use super::super::common::ShowSkuOptions; EXAMPLES: Show the machines assigned to a SKU: - $ carbide-admin-cli sku show-machines DGX-H100-640GB + $ nico-admin-cli sku show-machines DGX-H100-640GB ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/unassign/args.rs b/crates/admin-cli/src/sku/unassign/args.rs index 7d23d96d8e..c6a136e5ed 100644 --- a/crates/admin-cli/src/sku/unassign/args.rs +++ b/crates/admin-cli/src/sku/unassign/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Unassign whatever SKU is assigned to a machine: - $ carbide-admin-cli sku unassign 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli sku unassign 12345678-1234-5678-90ab-cdef01234567 Force the unassignment: - $ carbide-admin-cli sku unassign 12345678-1234-5678-90ab-cdef01234567 --force + $ nico-admin-cli sku unassign 12345678-1234-5678-90ab-cdef01234567 --force ")] pub struct Args { diff --git a/crates/admin-cli/src/sku/update_metadata/args.rs b/crates/admin-cli/src/sku/update_metadata/args.rs index 6999604a67..0dd3ad4b6e 100644 --- a/crates/admin-cli/src/sku/update_metadata/args.rs +++ b/crates/admin-cli/src/sku/update_metadata/args.rs @@ -23,13 +23,13 @@ use clap::{ArgGroup, Parser}; EXAMPLES: Update a SKU's description: - $ carbide-admin-cli sku update-metadata DGX-H100-640GB --description \"DGX H100 640GB\" + $ nico-admin-cli sku update-metadata DGX-H100-640GB --description \"DGX H100 640GB\" Update a SKU's device type: - $ carbide-admin-cli sku update-metadata DGX-H100-640GB --device-type gpu-server + $ nico-admin-cli sku update-metadata DGX-H100-640GB --device-type gpu-server Update both at once: - $ carbide-admin-cli sku update-metadata DGX-H100-640GB \ + $ nico-admin-cli sku update-metadata DGX-H100-640GB \ --description \"DGX H100 640GB\" --device-type gpu-server ")] diff --git a/crates/admin-cli/src/sku/verify/args.rs b/crates/admin-cli/src/sku/verify/args.rs index a7a54fe162..3c54af720e 100644 --- a/crates/admin-cli/src/sku/verify/args.rs +++ b/crates/admin-cli/src/sku/verify/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Verify a machine against its assigned SKU: - $ carbide-admin-cli sku verify 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli sku verify 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/spx_partition/show/args.rs b/crates/admin-cli/src/spx_partition/show/args.rs index 758c70f61a..61b10b39ab 100644 --- a/crates/admin-cli/src/spx_partition/show/args.rs +++ b/crates/admin-cli/src/spx_partition/show/args.rs @@ -23,16 +23,16 @@ use clap::Parser; EXAMPLES: List all SPX partitions: - $ carbide-admin-cli spx-partition show + $ nico-admin-cli spx-partition show Show one partition by ID: - $ carbide-admin-cli spx-partition show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli spx-partition show 12345678-1234-5678-90ab-cdef01234567 Filter by tenant org: - $ carbide-admin-cli spx-partition show --tenant-org-id fds34511233a + $ nico-admin-cli spx-partition show --tenant-org-id fds34511233a Filter by name: - $ carbide-admin-cli spx-partition show --name my-partition + $ nico-admin-cli spx-partition show --name my-partition ")] pub struct Args { diff --git a/crates/admin-cli/src/ssh/copy_bfb/args.rs b/crates/admin-cli/src/ssh/copy_bfb/args.rs index b4c5ef35b3..d97e5f3d94 100644 --- a/crates/admin-cli/src/ssh/copy_bfb/args.rs +++ b/crates/admin-cli/src/ssh/copy_bfb/args.rs @@ -24,7 +24,7 @@ use super::super::common::SshArgs; EXAMPLES: Copy a BFB image to a DPU BMC's RSHIM: - $ carbide-admin-cli ssh copy-bfb 192.0.2.10:22 admin mypassword /path/to/image.bfb + $ nico-admin-cli ssh copy-bfb 192.0.2.10:22 admin mypassword /path/to/image.bfb ")] pub struct Args { diff --git a/crates/admin-cli/src/ssh/disable_rshim/args.rs b/crates/admin-cli/src/ssh/disable_rshim/args.rs index b3f0fad9ad..e53c976150 100644 --- a/crates/admin-cli/src/ssh/disable_rshim/args.rs +++ b/crates/admin-cli/src/ssh/disable_rshim/args.rs @@ -27,7 +27,7 @@ use super::super::common::SshArgs; EXAMPLES: Disable the RSHIM interface on a DPU BMC: - $ carbide-admin-cli ssh disable-rshim 192.0.2.10:22 admin mypassword + $ nico-admin-cli ssh disable-rshim 192.0.2.10:22 admin mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/ssh/enable_rshim/args.rs b/crates/admin-cli/src/ssh/enable_rshim/args.rs index 06c70c6726..f377788647 100644 --- a/crates/admin-cli/src/ssh/enable_rshim/args.rs +++ b/crates/admin-cli/src/ssh/enable_rshim/args.rs @@ -27,7 +27,7 @@ use super::super::common::SshArgs; EXAMPLES: Enable the RSHIM interface on a DPU BMC: - $ carbide-admin-cli ssh enable-rshim 192.0.2.10:22 admin mypassword + $ nico-admin-cli ssh enable-rshim 192.0.2.10:22 admin mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/ssh/get_rshim_status/args.rs b/crates/admin-cli/src/ssh/get_rshim_status/args.rs index 8496859034..57ae0944e2 100644 --- a/crates/admin-cli/src/ssh/get_rshim_status/args.rs +++ b/crates/admin-cli/src/ssh/get_rshim_status/args.rs @@ -27,7 +27,7 @@ use super::super::common::SshArgs; EXAMPLES: Query the RSHIM status on a DPU BMC: - $ carbide-admin-cli ssh get-rshim-status 192.0.2.10:22 admin mypassword + $ nico-admin-cli ssh get-rshim-status 192.0.2.10:22 admin mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/ssh/show_obmc_log/args.rs b/crates/admin-cli/src/ssh/show_obmc_log/args.rs index 3c7c155d79..25b93fb49d 100644 --- a/crates/admin-cli/src/ssh/show_obmc_log/args.rs +++ b/crates/admin-cli/src/ssh/show_obmc_log/args.rs @@ -27,7 +27,7 @@ use super::super::common::SshArgs; EXAMPLES: Dump the OpenBMC log from a DPU BMC: - $ carbide-admin-cli ssh show-obmc-log 192.0.2.10:22 admin mypassword + $ nico-admin-cli ssh show-obmc-log 192.0.2.10:22 admin mypassword ")] pub struct Args { diff --git a/crates/admin-cli/src/switch/force_delete/args.rs b/crates/admin-cli/src/switch/force_delete/args.rs index 52ba7f99db..093075fa19 100644 --- a/crates/admin-cli/src/switch/force_delete/args.rs +++ b/crates/admin-cli/src/switch/force_delete/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: Force delete a switch: - $ carbide-admin-cli switch force-delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli switch force-delete 12345678-1234-5678-90ab-cdef01234567 Force delete a switch and its machine interfaces: - $ carbide-admin-cli switch force-delete 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces + $ nico-admin-cli switch force-delete 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces ")] pub struct Args { diff --git a/crates/admin-cli/src/switch/health_report/add/args.rs b/crates/admin-cli/src/switch/health_report/add/args.rs index f201d47315..2a10e3e286 100644 --- a/crates/admin-cli/src/switch/health_report/add/args.rs +++ b/crates/admin-cli/src/switch/health_report/add/args.rs @@ -26,15 +26,15 @@ use crate::machine::HealthReportTemplates; EXAMPLES: Add a health report source from a predefined template: - $ carbide-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template internal-maintenance --message \"Firmware upgrade in progress\" Add a health report source from raw JSON: - $ carbide-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 \ --health-report '{...}' Preview the report without sending it: - $ carbide-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 \ --template degraded --print-only ")] diff --git a/crates/admin-cli/src/switch/health_report/remove/args.rs b/crates/admin-cli/src/switch/health_report/remove/args.rs index 3c49e297bd..34020d1c2d 100644 --- a/crates/admin-cli/src/switch/health_report/remove/args.rs +++ b/crates/admin-cli/src/switch/health_report/remove/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Remove a health report source from a switch (source name from `health-report show`): - $ carbide-admin-cli switch health-report remove 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch health-report remove 12345678-1234-5678-90ab-cdef01234567 \ internal-maintenance ")] diff --git a/crates/admin-cli/src/switch/health_report/show/args.rs b/crates/admin-cli/src/switch/health_report/show/args.rs index db204e9476..c28ea9d00c 100644 --- a/crates/admin-cli/src/switch/health_report/show/args.rs +++ b/crates/admin-cli/src/switch/health_report/show/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: List the health report sources for a switch: - $ carbide-admin-cli switch health-report show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli switch health-report show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/switch/list/args.rs b/crates/admin-cli/src/switch/list/args.rs index 4c73002f50..cfa1aa8090 100644 --- a/crates/admin-cli/src/switch/list/args.rs +++ b/crates/admin-cli/src/switch/list/args.rs @@ -24,16 +24,16 @@ use rpc::forge::DeletedFilter; EXAMPLES: List all live switches: - $ carbide-admin-cli switch list + $ nico-admin-cli switch list Include deleted switches: - $ carbide-admin-cli switch list --deleted include + $ nico-admin-cli switch list --deleted include Filter by controller state: - $ carbide-admin-cli switch list --controller-state ready + $ nico-admin-cli switch list --controller-state ready Find a switch by its BMC MAC address: - $ carbide-admin-cli switch list --bmc-mac 00:11:22:33:44:55 + $ nico-admin-cli switch list --bmc-mac 00:11:22:33:44:55 ")] pub struct Args { diff --git a/crates/admin-cli/src/switch/metadata/args.rs b/crates/admin-cli/src/switch/metadata/args.rs index bc0fa24193..e88a2b73d6 100644 --- a/crates/admin-cli/src/switch/metadata/args.rs +++ b/crates/admin-cli/src/switch/metadata/args.rs @@ -37,7 +37,7 @@ pub enum Args { EXAMPLES: Show a switch's metadata: - $ carbide-admin-cli switch metadata show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli switch metadata show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct SwitchMetadataCommandShow { @@ -50,7 +50,7 @@ pub struct SwitchMetadataCommandShow { EXAMPLES: Set a switch's name and description: - $ carbide-admin-cli switch metadata set 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch metadata set 12345678-1234-5678-90ab-cdef01234567 \ --name spine-01 --description \"Rack 4 spine\" ")] @@ -68,10 +68,10 @@ pub struct SwitchMetadataCommandSet { EXAMPLES: Add a key-only label: - $ carbide-admin-cli switch metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge + $ nico-admin-cli switch metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge Add a key/value label: - $ carbide-admin-cli switch metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch metadata add-label 12345678-1234-5678-90ab-cdef01234567 \ --key env --value prod ")] @@ -89,7 +89,7 @@ pub struct SwitchMetadataCommandAddLabel { EXAMPLES: Remove one or more labels by key: - $ carbide-admin-cli switch metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 \ --keys env --keys edge ")] @@ -105,10 +105,10 @@ pub struct SwitchMetadataCommandRemoveLabels { EXAMPLES: Fill in missing metadata from the expected-switch (leaving existing values intact): - $ carbide-admin-cli switch metadata from-expected-switch 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli switch metadata from-expected-switch 12345678-1234-5678-90ab-cdef01234567 Overwrite the switch's metadata with the expected-switch's values: - $ carbide-admin-cli switch metadata from-expected-switch 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli switch metadata from-expected-switch 12345678-1234-5678-90ab-cdef01234567 \ --replace-all ")] diff --git a/crates/admin-cli/src/switch/show/args.rs b/crates/admin-cli/src/switch/show/args.rs index 06781dda9d..3e20fd290d 100644 --- a/crates/admin-cli/src/switch/show/args.rs +++ b/crates/admin-cli/src/switch/show/args.rs @@ -23,10 +23,10 @@ use clap::Parser; EXAMPLES: List all switches: - $ carbide-admin-cli switch show + $ nico-admin-cli switch show Show details for one switch: - $ carbide-admin-cli switch show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli switch show 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/tenant/show/args.rs b/crates/admin-cli/src/tenant/show/args.rs index 230409ee19..db5c7ef4d3 100644 --- a/crates/admin-cli/src/tenant/show/args.rs +++ b/crates/admin-cli/src/tenant/show/args.rs @@ -23,10 +23,10 @@ use rpc::forge::FindTenantRequest; EXAMPLES: List all tenants: - $ carbide-admin-cli tenant show + $ nico-admin-cli tenant show Show details for one tenant org: - $ carbide-admin-cli tenant show fds34511233a + $ nico-admin-cli tenant show fds34511233a ")] pub struct Args { diff --git a/crates/admin-cli/src/tenant/update/args.rs b/crates/admin-cli/src/tenant/update/args.rs index c912ad2c4d..3ba3eee433 100644 --- a/crates/admin-cli/src/tenant/update/args.rs +++ b/crates/admin-cli/src/tenant/update/args.rs @@ -22,13 +22,13 @@ use clap::Parser; EXAMPLES: Rename a tenant org: - $ carbide-admin-cli tenant update fds34511233a --name \"Acme Corp\" + $ nico-admin-cli tenant update fds34511233a --name \"Acme Corp\" Apply a routing profile to a tenant: - $ carbide-admin-cli tenant update fds34511233a --routing-profile-type default + $ nico-admin-cli tenant update fds34511233a --routing-profile-type default Update only if the record is still at a known version (optimistic concurrency): - $ carbide-admin-cli tenant update fds34511233a --name \"Acme Corp\" --version 7 + $ nico-admin-cli tenant update fds34511233a --name \"Acme Corp\" --version 7 ")] pub struct Args { diff --git a/crates/admin-cli/src/tenant_keyset/show/args.rs b/crates/admin-cli/src/tenant_keyset/show/args.rs index 15420669f7..5ce9626dca 100644 --- a/crates/admin-cli/src/tenant_keyset/show/args.rs +++ b/crates/admin-cli/src/tenant_keyset/show/args.rs @@ -25,13 +25,13 @@ use crate::errors::CarbideCliError; EXAMPLES: List all tenant keysets: - $ carbide-admin-cli tenant-key-set show + $ nico-admin-cli tenant-key-set show Show one keyset by its /: - $ carbide-admin-cli tenant-key-set show fds34511233a/87654321-4321-8765-cdef-0123456789ab + $ nico-admin-cli tenant-key-set show fds34511233a/87654321-4321-8765-cdef-0123456789ab Filter by tenant org: - $ carbide-admin-cli tenant-key-set show --tenant-org-id fds34511233a + $ nico-admin-cli tenant-key-set show --tenant-org-id fds34511233a ")] pub struct Args { diff --git a/crates/admin-cli/src/tpm_ca/add/args.rs b/crates/admin-cli/src/tpm_ca/add/args.rs index d7dbde2469..622c7eac5e 100644 --- a/crates/admin-cli/src/tpm_ca/add/args.rs +++ b/crates/admin-cli/src/tpm_ca/add/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Add a CA certificate from a DER/CER/PEM file: - $ carbide-admin-cli tpm-ca add --filename /path/to/tpm-ca.der + $ nico-admin-cli tpm-ca add --filename /path/to/tpm-ca.der ")] pub struct Args { diff --git a/crates/admin-cli/src/tpm_ca/add_bulk/args.rs b/crates/admin-cli/src/tpm_ca/add_bulk/args.rs index 0942460644..fb09ae03a5 100644 --- a/crates/admin-cli/src/tpm_ca/add_bulk/args.rs +++ b/crates/admin-cli/src/tpm_ca/add_bulk/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Add every certificate in a directory as a CA certificate: - $ carbide-admin-cli tpm-ca add-bulk --dirname /path/to/tpm-ca-certs/ + $ nico-admin-cli tpm-ca add-bulk --dirname /path/to/tpm-ca-certs/ ")] pub struct Args { diff --git a/crates/admin-cli/src/tpm_ca/delete/args.rs b/crates/admin-cli/src/tpm_ca/delete/args.rs index 5cb4c033cd..ab0b42137b 100644 --- a/crates/admin-cli/src/tpm_ca/delete/args.rs +++ b/crates/admin-cli/src/tpm_ca/delete/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Delete a TPM CA certificate by its id (from `tpm-ca show`): - $ carbide-admin-cli tpm-ca delete --ca-id 42 + $ nico-admin-cli tpm-ca delete --ca-id 42 ")] pub struct Args { diff --git a/crates/admin-cli/src/tpm_ca/show_unmatched_ek/args.rs b/crates/admin-cli/src/tpm_ca/show_unmatched_ek/args.rs index 49d45bcb12..c8ce0cd43b 100644 --- a/crates/admin-cli/src/tpm_ca/show_unmatched_ek/args.rs +++ b/crates/admin-cli/src/tpm_ca/show_unmatched_ek/args.rs @@ -22,7 +22,7 @@ use clap::Parser; EXAMPLES: Show TPM EK certificates that have no matching CA: - $ carbide-admin-cli tpm-ca show-unmatched-ek + $ nico-admin-cli tpm-ca show-unmatched-ek ")] pub struct Args; diff --git a/crates/admin-cli/src/trim_table/measured_boot/args.rs b/crates/admin-cli/src/trim_table/measured_boot/args.rs index 47342dd34f..a113acae27 100644 --- a/crates/admin-cli/src/trim_table/measured_boot/args.rs +++ b/crates/admin-cli/src/trim_table/measured_boot/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Keep the 1000 most recent measured-boot reports, deleting the rest: - $ carbide-admin-cli trim-table measured-boot --keep-entries 1000 + $ nico-admin-cli trim-table measured-boot --keep-entries 1000 Trim down to the latest report only: - $ carbide-admin-cli trim-table measured-boot --keep-entries 1 + $ nico-admin-cli trim-table measured-boot --keep-entries 1 ")] pub struct Args { diff --git a/crates/admin-cli/src/version/args.rs b/crates/admin-cli/src/version/args.rs index bea2430405..f9f94689fc 100644 --- a/crates/admin-cli/src/version/args.rs +++ b/crates/admin-cli/src/version/args.rs @@ -22,10 +22,10 @@ use clap::Parser; EXAMPLES: Show client and server versions: - $ carbide-admin-cli version + $ nico-admin-cli version Also display the runtime config: - $ carbide-admin-cli version --show-runtime-config + $ nico-admin-cli version --show-runtime-config ")] pub struct Opts { diff --git a/crates/admin-cli/src/version/cmds.rs b/crates/admin-cli/src/version/cmds.rs index b89117170e..ee357a236a 100644 --- a/crates/admin-cli/src/version/cmds.rs +++ b/crates/admin-cli/src/version/cmds.rs @@ -63,9 +63,9 @@ pub async fn handle_show_version( "carbide-api:\n\tbuild_version={}, build_date={}, git_sha={}, rust_version={}, build_user={}, build_hostname={}", v.build_version, v.build_date, v.git_sha, v.rust_version, v.build_user, v.build_hostname, ); - // Same as running `carbide-admin-cli --version` + // Same as running `nico-admin-cli --version` println!(); - println!("carbide-admin-cli:\n\t{}", carbide_version::version!()); + println!("nico-admin-cli:\n\t{}", carbide_version::version!()); if opts.show_runtime_config { let config = v diff --git a/crates/admin-cli/src/vpc/set_virtualizer/args.rs b/crates/admin-cli/src/vpc/set_virtualizer/args.rs index 02052c0434..4a528fd174 100644 --- a/crates/admin-cli/src/vpc/set_virtualizer/args.rs +++ b/crates/admin-cli/src/vpc/set_virtualizer/args.rs @@ -52,7 +52,7 @@ impl From for ::rpc::forge::VpcVirtualizationType { #[command(after_long_help = "\ EXAMPLES: Set virtualizer to FNN on VPC: - $ carbide-admin-cli vpc set-virtualizer 12345678-1234-5678-90ab-cdef01234567 fnn + $ nico-admin-cli vpc set-virtualizer 12345678-1234-5678-90ab-cdef01234567 fnn ")] pub struct Args { diff --git a/crates/admin-cli/src/vpc/show/args.rs b/crates/admin-cli/src/vpc/show/args.rs index 143200df8f..7e8bb84507 100644 --- a/crates/admin-cli/src/vpc/show/args.rs +++ b/crates/admin-cli/src/vpc/show/args.rs @@ -23,16 +23,16 @@ use clap::Parser; EXAMPLES: List all VPCs: - $ carbide-admin-cli vpc show + $ nico-admin-cli vpc show Show details for one VPC: - $ carbide-admin-cli vpc show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc show 12345678-1234-5678-90ab-cdef01234567 Filter by tenant org: - $ carbide-admin-cli vpc show --tenant-org-id fds34511233a + $ nico-admin-cli vpc show --tenant-org-id fds34511233a Filter by label: - $ carbide-admin-cli vpc show --label-key env --label-value prod + $ nico-admin-cli vpc show --label-key env --label-value prod ")] pub struct Args { diff --git a/crates/admin-cli/src/vpc_peering/create/args.rs b/crates/admin-cli/src/vpc_peering/create/args.rs index af1e57186a..64ec253e1f 100644 --- a/crates/admin-cli/src/vpc_peering/create/args.rs +++ b/crates/admin-cli/src/vpc_peering/create/args.rs @@ -25,11 +25,11 @@ use rpc::forge::VpcPeeringCreationRequest; EXAMPLES: Peer two VPCs: - $ carbide-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 Peer two VPCs with a chosen peering ID: - $ carbide-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 \ abcdef01-2345-6789-abcd-ef0123456789 --id 0fedcba9-8765-4321-0fed-cba987654321 ")] diff --git a/crates/admin-cli/src/vpc_peering/delete/args.rs b/crates/admin-cli/src/vpc_peering/delete/args.rs index e69258544d..0cfb54ac85 100644 --- a/crates/admin-cli/src/vpc_peering/delete/args.rs +++ b/crates/admin-cli/src/vpc_peering/delete/args.rs @@ -23,7 +23,7 @@ use clap::Parser; EXAMPLES: Delete a VPC peering: - $ carbide-admin-cli vpc-peering delete --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc-peering delete --id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/vpc_peering/show/args.rs b/crates/admin-cli/src/vpc_peering/show/args.rs index b69df66521..2583a8c428 100644 --- a/crates/admin-cli/src/vpc_peering/show/args.rs +++ b/crates/admin-cli/src/vpc_peering/show/args.rs @@ -24,13 +24,13 @@ use clap::Parser; EXAMPLES: List all VPC peerings: - $ carbide-admin-cli vpc-peering show + $ nico-admin-cli vpc-peering show Show details for one VPC peering: - $ carbide-admin-cli vpc-peering show --id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc-peering show --id 12345678-1234-5678-90ab-cdef01234567 List the peerings for one VPC: - $ carbide-admin-cli vpc-peering show --vpc-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc-peering show --vpc-id 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/vpc_prefix/create/args.rs b/crates/admin-cli/src/vpc_prefix/create/args.rs index dbdbdae9cb..33ae2ea024 100644 --- a/crates/admin-cli/src/vpc_prefix/create/args.rs +++ b/crates/admin-cli/src/vpc_prefix/create/args.rs @@ -25,11 +25,11 @@ use rpc::forge::VpcPrefixCreationRequest; EXAMPLES: Create a prefix in a VPC: - $ carbide-admin-cli vpc-prefix create --vpc-id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli vpc-prefix create --vpc-id 12345678-1234-5678-90ab-cdef01234567 \ --prefix 10.0.0.0/24 --name web-tier Create a prefix with a description and labels: - $ carbide-admin-cli vpc-prefix create --vpc-id 12345678-1234-5678-90ab-cdef01234567 \ + $ nico-admin-cli vpc-prefix create --vpc-id 12345678-1234-5678-90ab-cdef01234567 \ --prefix 10.0.0.0/24 --name web-tier --description \"Front-end subnet\" \ --label environment:production --label team:platform diff --git a/crates/admin-cli/src/vpc_prefix/delete/args.rs b/crates/admin-cli/src/vpc_prefix/delete/args.rs index bbcc5d9c30..d71c70c93e 100644 --- a/crates/admin-cli/src/vpc_prefix/delete/args.rs +++ b/crates/admin-cli/src/vpc_prefix/delete/args.rs @@ -24,7 +24,7 @@ use rpc::forge::VpcPrefixDeletionRequest; EXAMPLES: Delete a VPC prefix by ID: - $ carbide-admin-cli vpc-prefix delete 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc-prefix delete 12345678-1234-5678-90ab-cdef01234567 ")] pub struct Args { diff --git a/crates/admin-cli/src/vpc_prefix/show/args.rs b/crates/admin-cli/src/vpc_prefix/show/args.rs index d6186f748e..b739ae7f3b 100644 --- a/crates/admin-cli/src/vpc_prefix/show/args.rs +++ b/crates/admin-cli/src/vpc_prefix/show/args.rs @@ -27,22 +27,22 @@ use crate::vpc_prefix::common::VpcPrefixSelector; EXAMPLES: List all VPC prefixes: - $ carbide-admin-cli vpc-prefix show + $ nico-admin-cli vpc-prefix show Show one prefix by ID: - $ carbide-admin-cli vpc-prefix show 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc-prefix show 12345678-1234-5678-90ab-cdef01234567 Show one prefix by its exact CIDR: - $ carbide-admin-cli vpc-prefix show 10.0.0.0/24 + $ nico-admin-cli vpc-prefix show 10.0.0.0/24 List the prefixes belonging to one VPC: - $ carbide-admin-cli vpc-prefix show --vpc-id 12345678-1234-5678-90ab-cdef01234567 + $ nico-admin-cli vpc-prefix show --vpc-id 12345678-1234-5678-90ab-cdef01234567 Find the prefix that contains an address: - $ carbide-admin-cli vpc-prefix show --contains 10.0.0.5 + $ nico-admin-cli vpc-prefix show --contains 10.0.0.5 Find the prefixes contained by a larger prefix: - $ carbide-admin-cli vpc-prefix show --contained-by 10.0.0.0/16 + $ nico-admin-cli vpc-prefix show --contained-by 10.0.0.0/16 ")] pub struct Args { diff --git a/dev/deployment/devspace/Dockerfile.api b/dev/deployment/devspace/Dockerfile.api index fd76c6157b..e200940e4a 100644 --- a/dev/deployment/devspace/Dockerfile.api +++ b/dev/deployment/devspace/Dockerfile.api @@ -27,9 +27,9 @@ COPY . . RUN --mount=type=cache,id=nico-devspace-cargo-home,target=/cargo-home,sharing=locked \ --mount=type=cache,id=nico-devspace-cargo-target,target=/cargo-target,sharing=locked \ - cargo build -p carbide-api --bin carbide-api -p carbide-admin-cli --bin carbide-admin-cli --locked && \ + cargo build -p carbide-api --bin carbide-api -p nico-admin-cli --locked && \ mkdir -p /artifacts && \ - cp /cargo-target/debug/carbide-api /cargo-target/debug/carbide-admin-cli /artifacts/ + cp /cargo-target/debug/carbide-api /cargo-target/debug/nico-admin-cli /artifacts/ FROM ubuntu:24.04 @@ -46,7 +46,8 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ RUN mkdir -p /opt/carbide /opt/carbide/firmware /mnt/persistence /var/run/kea COPY --from=builder /artifacts/carbide-api /opt/carbide/carbide-api -COPY --from=builder /artifacts/carbide-admin-cli /opt/carbide/carbide-admin-cli +COPY --from=builder /artifacts/nico-admin-cli /opt/carbide/nico-admin-cli +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli COPY crates/api/casbin-policy.csv /opt/carbide/casbin-policy.csv ENV CASBIN_POLICY_FILE=/opt/carbide/casbin-policy.csv diff --git a/dev/deployment/localdev/Dockerfile.api.localdev b/dev/deployment/localdev/Dockerfile.api.localdev index c1b2c4e1b0..8e5c9d31bf 100644 --- a/dev/deployment/localdev/Dockerfile.api.localdev +++ b/dev/deployment/localdev/Dockerfile.api.localdev @@ -20,8 +20,9 @@ FROM runtime-container-localdev:latest as carbide WORKDIR ./carbide COPY .skaffold/target/carbide-api/debug/carbide-api /opt/carbide/ -COPY .skaffold/target/carbide-admin-cli/debug/carbide-admin-cli /opt/carbide/ -RUN ln -s /opt/carbide/carbide-admin-cli /opt/carbide/forge-admin-cli +COPY .skaffold/target/nico-admin-cli/debug/nico-admin-cli /opt/carbide/ +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli && \ + ln -s /opt/carbide/nico-admin-cli /opt/carbide/forge-admin-cli COPY crates/api/casbin-policy.csv /opt/carbide/ COPY pxe/static/blobs/internal/aarch64/secure-boot-pk.pem /forge-boot-artifacts/blobs/internal/aarch64/secure-boot-pk.pem COPY pxe/static/blobs/internal/aarch64/preingestion.bfb /forge-boot-artifacts/blobs/internal/aarch64/preingestion.bfb diff --git a/dev/deployment/localdev/Dockerfile.api.localdev.minikube b/dev/deployment/localdev/Dockerfile.api.localdev.minikube index 3dc3fc1304..8e0cde8e8d 100644 --- a/dev/deployment/localdev/Dockerfile.api.localdev.minikube +++ b/dev/deployment/localdev/Dockerfile.api.localdev.minikube @@ -20,7 +20,8 @@ FROM registry.minikube/runtime-container:latest as carbide WORKDIR ./carbide COPY .skaffold/target/carbide-api/debug/carbide-api /opt/carbide/ -COPY .skaffold/target/carbide-admin-cli/debug/carbide-admin-cli /opt/carbide/ -RUN ln -s /opt/carbide/carbide-admin-cli /opt/carbide/forge-admin-cli +COPY .skaffold/target/nico-admin-cli/debug/nico-admin-cli /opt/carbide/ +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli && \ + ln -s /opt/carbide/nico-admin-cli /opt/carbide/forge-admin-cli COPY crates/api/casbin-policy.csv /opt/carbide/ ENV CASBIN_POLICY_FILE=/opt/carbide/casbin-policy.csv diff --git a/dev/deployment/localdev/Dockerfile.forge-admin-cli.localdev b/dev/deployment/localdev/Dockerfile.forge-admin-cli.localdev index 2e736cd864..0a9a63f97b 100644 --- a/dev/deployment/localdev/Dockerfile.forge-admin-cli.localdev +++ b/dev/deployment/localdev/Dockerfile.forge-admin-cli.localdev @@ -20,7 +20,8 @@ FROM runtime-container-localdev:latest as carbide WORKDIR /opt/carbide -COPY .skaffold/target/carbide-admin-cli/debug/carbide-admin-cli /opt/carbide/ -RUN ln -s /opt/carbide/carbide-admin-cli /opt/carbide/forge-admin-cli +COPY .skaffold/target/nico-admin-cli/debug/nico-admin-cli /opt/carbide/ +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli && \ + ln -s /opt/carbide/nico-admin-cli /opt/carbide/forge-admin-cli ENV PATH="/opt/carbide:${PATH}" diff --git a/dev/docker/Dockerfile.release-container-aarch64 b/dev/docker/Dockerfile.release-container-aarch64 index f425320404..a48855abf6 100644 --- a/dev/docker/Dockerfile.release-container-aarch64 +++ b/dev/docker/Dockerfile.release-container-aarch64 @@ -59,10 +59,11 @@ RUN mkdir -p /opt/carbide/migrations && \ RUN echo "$(date): Start runtime container build" -COPY --from=builder ["/carbide/target/bin/carbide-api", "/carbide/target/bin/carbide", "/carbide/target/bin/carbide-dns", "/carbide/target/bin/carbide-admin-cli", "/carbide/target/bin/carbide-dsx-exchange-consumer", "/carbide/target/bin/forge-dpu-agent", "/carbide/target/bin/forge-dhcp-server", "/carbide/target/bin/forge-hw-health", "/carbide/target/bin/forge-log-parser", "/carbide/target/bin/ssh-console", "/carbide/target/bin/carbide-bmc-proxy", "/opt/carbide/"] +COPY --from=builder ["/carbide/target/bin/carbide-api", "/carbide/target/bin/carbide", "/carbide/target/bin/carbide-dns", "/carbide/target/bin/nico-admin-cli", "/carbide/target/bin/carbide-dsx-exchange-consumer", "/carbide/target/bin/forge-dpu-agent", "/carbide/target/bin/forge-dhcp-server", "/carbide/target/bin/forge-hw-health", "/carbide/target/bin/forge-log-parser", "/carbide/target/bin/ssh-console", "/carbide/target/bin/carbide-bmc-proxy", "/opt/carbide/"] # Note: aarch64 uses different library path than x86_64 COPY --from=builder /carbide/target/bin/libdhcp.so /usr/lib/aarch64-linux-gnu/kea/hooks -RUN ln -s /opt/carbide/carbide-admin-cli /opt/carbide/forge-admin-cli +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli && \ + ln -s /opt/carbide/nico-admin-cli /opt/carbide/forge-admin-cli RUN echo "$(date): Finished copies" diff --git a/dev/docker/Dockerfile.release-container-sa-x86_64 b/dev/docker/Dockerfile.release-container-sa-x86_64 index 256ca1a465..8ce81892d5 100644 --- a/dev/docker/Dockerfile.release-container-sa-x86_64 +++ b/dev/docker/Dockerfile.release-container-sa-x86_64 @@ -82,9 +82,10 @@ RUN mkdir -p /opt/carbide/migrations && \ RUN echo "$(date): Start runtime container build" -COPY --from=builder ["/carbide/target/bin/carbide-api", "/carbide/target/bin/carbide", "/carbide/target/bin/carbide-dns", "/carbide/target/bin/carbide-admin-cli", "/carbide/target/bin/carbide-dsx-exchange-consumer", "/carbide/target/bin/forge-dpu-agent", "/carbide/target/bin/forge-dhcp-server", "/carbide/target/bin/forge-hw-health", "/carbide/target/bin/forge-log-parser", "/carbide/target/bin/ssh-console", "/carbide/target/bin/carbide-bmc-proxy", "/opt/carbide/"] +COPY --from=builder ["/carbide/target/bin/carbide-api", "/carbide/target/bin/carbide", "/carbide/target/bin/carbide-dns", "/carbide/target/bin/nico-admin-cli", "/carbide/target/bin/carbide-dsx-exchange-consumer", "/carbide/target/bin/forge-dpu-agent", "/carbide/target/bin/forge-dhcp-server", "/carbide/target/bin/forge-hw-health", "/carbide/target/bin/forge-log-parser", "/carbide/target/bin/ssh-console", "/carbide/target/bin/carbide-bmc-proxy", "/opt/carbide/"] COPY --from=builder /carbide/target/bin/libdhcp.so /usr/lib/x86_64-linux-gnu/kea/hooks -RUN ln -s /opt/carbide/carbide-admin-cli /opt/carbide/forge-admin-cli +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli && \ + ln -s /opt/carbide/nico-admin-cli /opt/carbide/forge-admin-cli RUN echo "$(date): Finished copies" diff --git a/dev/docker/Dockerfile.release-container-x86_64 b/dev/docker/Dockerfile.release-container-x86_64 index 9989ff777e..f2b3685896 100644 --- a/dev/docker/Dockerfile.release-container-x86_64 +++ b/dev/docker/Dockerfile.release-container-x86_64 @@ -59,9 +59,10 @@ RUN mkdir -p /opt/carbide/migrations && \ RUN echo "$(date): Start runtime container build" -COPY --from=builder ["/carbide/target/bin/carbide-api", "/carbide/target/bin/carbide", "/carbide/target/bin/carbide-dns", "/carbide/target/bin/carbide-admin-cli", "/carbide/target/bin/carbide-dsx-exchange-consumer", "/carbide/target/bin/forge-dpu-agent", "/carbide/target/bin/forge-dhcp-server", "/carbide/target/bin/forge-hw-health", "/carbide/target/bin/forge-log-parser", "/carbide/target/bin/ssh-console", "/carbide/target/bin/carbide-bmc-proxy", "/opt/carbide/"] +COPY --from=builder ["/carbide/target/bin/carbide-api", "/carbide/target/bin/carbide", "/carbide/target/bin/carbide-dns", "/carbide/target/bin/nico-admin-cli", "/carbide/target/bin/carbide-dsx-exchange-consumer", "/carbide/target/bin/forge-dpu-agent", "/carbide/target/bin/forge-dhcp-server", "/carbide/target/bin/forge-hw-health", "/carbide/target/bin/forge-log-parser", "/carbide/target/bin/ssh-console", "/carbide/target/bin/carbide-bmc-proxy", "/opt/carbide/"] COPY --from=builder /carbide/target/bin/libdhcp.so /usr/lib/x86_64-linux-gnu/kea/hooks -RUN ln -s /opt/carbide/carbide-admin-cli /opt/carbide/forge-admin-cli +RUN ln -s /opt/carbide/nico-admin-cli /opt/carbide/carbide-admin-cli && \ + ln -s /opt/carbide/nico-admin-cli /opt/carbide/forge-admin-cli RUN echo "$(date): Finished copies" diff --git a/dev/docker/Dockerfile.release-forge-cli b/dev/docker/Dockerfile.release-forge-cli index 1ba0220c80..73a1e58e4a 100644 --- a/dev/docker/Dockerfile.release-forge-cli +++ b/dev/docker/Dockerfile.release-forge-cli @@ -30,7 +30,7 @@ RUN --mount=type=cache,id=sccache-x86_64,target=/sccache \ export SCCACHE_DIR=/sccache && \ export RUSTC_WRAPPER=sccache && \ export CARGO_PROFILE_RELEASE_DEBUG=true && \ - cargo build --release -p carbide-admin-cli + cargo build --release -p nico-admin-cli FROM debian:12-slim ARG CI_COMMIT_SHORT_SHA @@ -42,8 +42,9 @@ RUN apt update && \ libtss2-dev WORKDIR /app -COPY --from=builder /carbide/target/release/carbide-admin-cli ./ -# Cert paths read by carbide-admin-cli via carbide_api_cli.json. +COPY --from=builder /carbide/target/release/nico-admin-cli ./ +RUN ln -s /app/nico-admin-cli /app/carbide-admin-cli +# Cert paths read by nico-admin-cli via carbide_api_cli.json. # Internal deployments: mount provisioned client certs into /root/.config/carbide/certs/. RUN mkdir -p /root/.config/carbide/certs && \ mkdir -p /opt/forge @@ -51,4 +52,4 @@ COPY ./dev/certs/forge_root.pem /opt/forge RUN echo '{"forge_root_ca_path": "/opt/forge/forge_root.pem","client_key_path": "/root/.config/carbide/certs/client","client_cert_path": "/root/.config/carbide/certs/client.crt"}' > /root/.config/carbide_api_cli.json ENV PATH="$PATH:/app" -ENTRYPOINT ["/app/carbide-admin-cli"] +ENTRYPOINT ["/app/nico-admin-cli"] diff --git a/dev/mac-local-dev/run-carbide-admin-cli.sh b/dev/mac-local-dev/run-nico-admin-cli.sh similarity index 63% rename from dev/mac-local-dev/run-carbide-admin-cli.sh rename to dev/mac-local-dev/run-nico-admin-cli.sh index 0ec0541f65..b34f7050b5 100755 --- a/dev/mac-local-dev/run-carbide-admin-cli.sh +++ b/dev/mac-local-dev/run-nico-admin-cli.sh @@ -3,19 +3,19 @@ # SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 # -# Wrapper to run carbide-admin-cli against the local dev carbide-api instance +# Wrapper to run nico-admin-cli against the local dev carbide-api instance # started by run-carbide-api.sh. # # Usage (from repo root or any directory): -# ./dev/mac-local-dev/run-carbide-admin-cli.sh [args...] +# ./dev/mac-local-dev/run-nico-admin-cli.sh [args...] # # Examples: -# ./dev/mac-local-dev/run-carbide-admin-cli.sh version -# ./dev/mac-local-dev/run-carbide-admin-cli.sh machine show -# ./dev/mac-local-dev/run-carbide-admin-cli.sh ipxe-template list -# ./dev/mac-local-dev/run-carbide-admin-cli.sh ipxe-template get ubuntu-24.04-netboot -# ./dev/mac-local-dev/run-carbide-admin-cli.sh os-image show -# ./dev/mac-local-dev/run-carbide-admin-cli.sh --format json ipxe-template list +# ./dev/mac-local-dev/run-nico-admin-cli.sh version +# ./dev/mac-local-dev/run-nico-admin-cli.sh machine show +# ./dev/mac-local-dev/run-nico-admin-cli.sh ipxe-template list +# ./dev/mac-local-dev/run-nico-admin-cli.sh ipxe-template get ubuntu-24.04-netboot +# ./dev/mac-local-dev/run-nico-admin-cli.sh os-image show +# ./dev/mac-local-dev/run-nico-admin-cli.sh --format json ipxe-template list # set -euo pipefail @@ -31,11 +31,11 @@ FORGE_ROOT_CA_PATH="${FORGE_ROOT_CA_PATH:-$REPO_ROOT/dev/certs/localhost/ca.crt} CLIENT_CERT_PATH="${CLIENT_CERT_PATH:-$REPO_ROOT/dev/certs/localhost/client.crt}" CLIENT_KEY_PATH="${CLIENT_KEY_PATH:-$REPO_ROOT/dev/certs/localhost/client.key}" -CLI_BIN="$REPO_ROOT/target/debug/carbide-admin-cli" +CLI_BIN="$REPO_ROOT/target/debug/nico-admin-cli" if [ ! -x "$CLI_BIN" ]; then echo "Binary not found at $CLI_BIN — building first..." - cargo build -p carbide-admin-cli --manifest-path "$REPO_ROOT/Cargo.toml" + cargo build -p nico-admin-cli --manifest-path "$REPO_ROOT/Cargo.toml" fi exec "$CLI_BIN" \ diff --git a/docs/index.yml b/docs/index.yml index 5e4e6f8355..79ff3d7fc4 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -243,7 +243,7 @@ navigation: path: development/vm_pxe_client.md - page: TLS and SPIFFE Certificates path: development/tls.md - - page: SPIFFE and casbin policies with admin-cli + - page: nico-admin-cli path: manuals/nico-admin-cli.md - page: Re-creating Issuer/CA in Local Dev path: development/issuer_ca_recreate.md diff --git a/docs/manuals/dpf.md b/docs/manuals/dpf.md index 3c5ad46ed5..514159f6fd 100644 --- a/docs/manuals/dpf.md +++ b/docs/manuals/dpf.md @@ -565,13 +565,13 @@ provisioned via DPF only when **both** of the following are true: There are several operator paths that can set this field. They are described below in the order an operator typically uses them. -#### 3.6.a. `carbide-admin-cli expected-machine add` — create a new entry +#### 3.6.a. `nico-admin-cli expected-machine add` — create a new entry Adds a new expected-machine row. `--dpf-enabled` is optional; **omitting it stores `false`**. ```bash -carbide-admin-cli expected-machine add \ +nico-admin-cli expected-machine add \ --bmc-mac-address 1a:1b:1c:1d:1e:1f \ --bmc-username admin \ --bmc-password secret \ @@ -579,20 +579,20 @@ carbide-admin-cli expected-machine add \ --dpf-enabled true ``` -#### 3.6.b. `carbide-admin-cli expected-machine patch` — partial update via flags +#### 3.6.b. `nico-admin-cli expected-machine patch` — partial update via flags Updates an existing entry in place. The lookup key is `--bmc-mac-address` (or `--id `). Omitting `--dpf-enabled` **preserves** the existing value. ```bash -carbide-admin-cli expected-machine patch \ +nico-admin-cli expected-machine patch \ --bmc-mac-address 1a:1b:1c:1d:1e:1f \ --chassis-serial-number CHASSIS-SN-001 \ --dpf-enabled true ``` -#### 3.6.c. `carbide-admin-cli expected-machine update --filename` — single-host update from JSON +#### 3.6.c. `nico-admin-cli expected-machine update --filename` — single-host update from JSON Updates one entry from a JSON file. The JSON shape uses `chassis_serial_number` (not `serial_number`) and any field omitted from the @@ -611,13 +611,13 @@ file is **preserved** server-side. ``` ```bash -carbide-admin-cli expected-machine update --filename em.json +nico-admin-cli expected-machine update --filename em.json ``` This is the most ergonomic path for "toggle DPF on one already-existing expected machine without touching anything else." -#### 3.6.d. `carbide-admin-cli expected-machine replace-all --filename` — destructive full reload +#### 3.6.d. `nico-admin-cli expected-machine replace-all --filename` — destructive full reload Wipes the entire `expected_machines` table and re-creates it from the file. The file shape is a wrapper object whose `expected_machines` array uses the @@ -640,7 +640,7 @@ same per-entry shape as `update`: ``` ```bash -carbide-admin-cli expected-machine replace-all --filename em-all.json +nico-admin-cli expected-machine replace-all --filename em-all.json ``` > **Important**: this is **not a merge**. Any expected-machine row that is @@ -652,23 +652,23 @@ carbide-admin-cli expected-machine replace-all --filename em-all.json | Goal | Path | |---|---| -| Add a new host with DPF enabled | `carbide-admin-cli expected-machine add … --dpf-enabled true` | -| Flip DPF on an existing entry, preserving everything else | `carbide-admin-cli expected-machine update --filename em.json` | -| Flip DPF inline with one or more other fields | `carbide-admin-cli expected-machine patch … --dpf-enabled true` | -| Replace the entire inventory | `carbide-admin-cli expected-machine replace-all --filename em-all.json` | -| Inspect current value | `carbide-admin-cli expected-machine show ` | +| Add a new host with DPF enabled | `nico-admin-cli expected-machine add … --dpf-enabled true` | +| Flip DPF on an existing entry, preserving everything else | `nico-admin-cli expected-machine update --filename em.json` | +| Flip DPF inline with one or more other fields | `nico-admin-cli expected-machine patch … --dpf-enabled true` | +| Replace the entire inventory | `nico-admin-cli expected-machine replace-all --filename em-all.json` | +| Inspect current value | `nico-admin-cli expected-machine show ` | ### 3.7 Enabling DPF for Existing (Ingested) Nodes You can enable the DPF flag on an already discovered host without force-deleting or recreating it by using: ```bash -carbide-admin-cli dpf enable +nico-admin-cli dpf enable ``` After changing the DPF status for a host in this way, you should trigger a reprovisioning for all the DPUs under a host (using its host ID). For environments where a host has multiple DPUs, make sure to trigger reprovisioning for all DPUs under the host; otherwise, NICo will not transition the node to DPF-managed status. -**Note:** The `carbide-admin-cli dpf enable` command updates the DPF flag only for the currently ingested machine. If you later force-delete the host, this change is lost—on rediscovery, the DPF setting will revert to whatever is present in your `expected_machines` database. +**Note:** The `nico-admin-cli dpf enable` command updates the DPF flag only for the currently ingested machine. If you later force-delete the host, this change is lost—on rediscovery, the DPF setting will revert to whatever is present in your `expected_machines` database. --- @@ -702,9 +702,9 @@ configuration to take effect. --- -## Appendix: `carbide-admin-cli dpf` command reference +## Appendix: `nico-admin-cli dpf` command reference -`carbide-admin-cli` ships a top-level `dpf` subcommand group for inspecting and +`nico-admin-cli` ships a top-level `dpf` subcommand group for inspecting and toggling DPF state on already-ingested hosts and for diffing the running DPF service stack against the configured one. The full set is listed below. @@ -718,7 +718,7 @@ service stack against the configured one. The full set is listed below. ### `dpf enable` — turn DPF on for a host ```bash -carbide-admin-cli dpf enable +nico-admin-cli dpf enable ``` | Argument | Required | Notes | @@ -732,10 +732,10 @@ the `ModifyDPFState` RPC. ```bash # One host -carbide-admin-cli dpf show +nico-admin-cli dpf show # All hosts (paginated by --page-size) -carbide-admin-cli dpf show +nico-admin-cli dpf show ``` | Argument | Required | Notes | @@ -749,7 +749,7 @@ from the all-hosts list. ### `dpf snapshot` — dump DPF CRs for a host ```bash -carbide-admin-cli dpf snapshot +nico-admin-cli dpf snapshot ``` | Argument | Required | Notes | @@ -763,9 +763,9 @@ why a host is stuck during DPF-based provisioning. ### `dpf service-version` (alias: `sv`) — diff configured vs. deployed services ```bash -carbide-admin-cli dpf service-version +nico-admin-cli dpf service-version # or -carbide-admin-cli dpf sv +nico-admin-cli dpf sv ``` No arguments. Prints a table comparing each configured DPF service @@ -789,8 +789,8 @@ configured versions onto the cluster. | Goal | Command | |---|---| -| Turn DPF on for an already-discovered host (transient) | `carbide-admin-cli dpf enable ` | -| Show DPF state for one host | `carbide-admin-cli dpf show ` | -| List DPF state for all hosts | `carbide-admin-cli dpf show` | -| Snapshot DPF CRs for a host | `carbide-admin-cli dpf snapshot ` | -| Diff configured vs. deployed DPF service versions | `carbide-admin-cli dpf service-version` | +| Turn DPF on for an already-discovered host (transient) | `nico-admin-cli dpf enable ` | +| Show DPF state for one host | `nico-admin-cli dpf show ` | +| List DPF state for all hosts | `nico-admin-cli dpf show` | +| Snapshot DPF CRs for a host | `nico-admin-cli dpf snapshot ` | +| Diff configured vs. deployed DPF service versions | `nico-admin-cli dpf service-version` | diff --git a/docs/manuals/nico-admin-cli.md b/docs/manuals/nico-admin-cli.md index d41e584ae1..8c4c4d0e12 100644 --- a/docs/manuals/nico-admin-cli.md +++ b/docs/manuals/nico-admin-cli.md @@ -30,12 +30,19 @@ The CLI needs three things to connect: ### TLS options -| Flag | Environment variable | Config file key | Description | -|------|---------------------|-----------------|-------------| -| `-c` / `--nico-api` | `NICO_API_URL` | `nico_api_url` | nico-api URL | -| `--nico-root-ca-path` | `NICO_ROOT_CA_PATH` | `nico_root_ca_path` | Root CA cert (PEM) used to verify the server | -| `--client-cert-path` | `CLIENT_CERT_PATH` | `client_cert_path` | Client certificate (PEM) | -| `--client-key-path` | `CLIENT_KEY_PATH` | `client_key_path` | Client private key (PEM) | +Every setting follows the same priority: CLI flag → environment variable → +config file key → hard-coded default (where one exists). + +| Setting | CLI flag | Environment variable | Config file key | Default | +|---------|----------|---------------------|-----------------|---------| +| API URL | `-a` / `--api-url` | `API_URL` | `api_url` | `https://nico-api.forge-system.svc.cluster.local:1079` | +| Server root CA | `--root-ca-path` | `ROOT_CA_PATH` | `root_ca_path` | — | +| Client cert | `--client-cert-path` | `CLIENT_CERT_PATH` | `client_cert_path` | see [Client-cert fallbacks](#client-cert-fallbacks) | +| Client key | `--client-key-path` | `CLIENT_KEY_PATH` | `client_key_path` | same chain as client cert | +| RMS API URL | `--rms-api-url` | `RMS_API_URL` | — | — | +| RMS root CA | `--rms-root-ca-path` | `RMS_ROOT_CA_PATH` | `rms_root_ca_path` | — | +| RMS client cert | `--rms-client-cert-path` | `RMS_CLIENT_CERT_PATH` | — | — | +| RMS client key | `--rms-client-key-path` | `RMS_CLIENT_KEY_PATH` | — | — | ### Config file @@ -44,10 +51,11 @@ Instead of passing flags every time, create ```json { - "nico_api_url": "https://nico-api.example.com:1079", - "nico_root_ca_path": "/etc/nico/certs/ca.crt", + "api_url": "https://nico-api.example.com:1079", + "root_ca_path": "/etc/nico/certs/ca.crt", "client_cert_path": "/etc/nico/certs/client.crt", - "client_key_path": "/etc/nico/certs/client.key" + "client_key_path": "/etc/nico/certs/client.key", + "rms_root_ca_path": "/etc/nico/certs/rms-ca.crt" } ``` @@ -56,8 +64,8 @@ Instead of passing flags every time, create ```sh # Explicit flags nico-admin-cli \ - -c https://nico-api.example.com:1079 \ - --nico-root-ca-path /etc/nico/certs/ca.crt \ + --api-url https://nico-api.example.com:1079 \ + --root-ca-path /etc/nico/certs/ca.crt \ --client-cert-path /etc/nico/certs/client.crt \ --client-key-path /etc/nico/certs/client.key \ version @@ -66,289 +74,67 @@ nico-admin-cli \ nico-admin-cli version ``` -### SOCKS5 proxy support +### SOCKS5 proxy -If the CLI needs to reach nico-api through a SOCKS5 proxy, set one -of: `http_proxy`, `https_proxy`, `HTTP_PROXY`, or `HTTPS_PROXY`. Only -the `socks5://` scheme is supported. - -## Generating client certificates - -nico-api uses mTLS: the server verifies the client's certificate -against a trusted CA. - -### Creating an admin CA and client cert with OpenSSL - -The following creates a self-contained CA and client certificate. In -production you would typically use your organization's existing PKI -instead of a self-signed CA. +The CLI honors `http_proxy` / `https_proxy` (or their uppercase variants) +**only when the URL scheme is `socks5`**. HTTP/HTTPS proxies are rejected +with a "Only SOCKS5 Proxy supported" error. This is enforced in +`get_proxy_info()`; see `crates/tls/src/client_config.rs`. ```sh -# 1. Generate the CA key and self-signed certificate -openssl ecparam -name prime256v1 -genkey -noout -out admin-ca.key -openssl req -x509 -new -key admin-ca.key -sha256 -days 3650 \ - -out admin-ca.crt \ - -subj "/O=ExampleCo/CN=ExampleCo NICo Admin CA" - -# 2. Generate a client key -openssl ecparam -name prime256v1 -genkey -noout -out client.key - -# 3. Create a CSR with operator identity in the subject -# - O = organization (matched by required_equals if configured) -# - OU = group (used for role-based authorization via group_from) -# - CN = username (used for audit logging via username_from) -openssl req -new -key client.key -out client.csr \ - -subj "/O=ExampleCo/OU=site-admins/CN=jdoe" - -# 4. Create an extensions file for clientAuth -cat > client_ext.cnf <` | `external-role/site-admins` | -| Any trusted cert | `trusted-certificate` | | -| No cert | `anonymous` | | - -The `` in `external-role/` comes from the certificate -field specified by `group_from` in `[auth.cli_certs]`. - -##### Writing policy rules - -Sample policy file: - -```csv -# On `g` rules: These associate a principal (second column) with a role name -# (third column). This causes the named role to also be looked up as if it were -# a principal. -# -# On `p` rules: These allow a principal or role (second column) to perform the -# named action (third column). Glob matching is available on the action field. -# - - -# Map the nico-dhcp SPIFFE ID to the nico-dhcp role. -# FIXME: verify that this is how these SPIFFE service identifiers look in reality. -g, spiffe-service-id/nico-dhcp, nico-dhcp -g, spiffe-service-id/nico-dns, nico-dns -g, spiffe-machine-id, machine - -# Allow the nico-dhcp role to call its methods. -p, nico-dhcp, nico/DiscoverDhcp - -# Same idea for nico-dns. -p, nico-dns, nico/LookupRecord - -# Anonymous access to endpoints that don't modify state or expose any customer -# or site data should be fine. -p, anonymous, nico/Version - -# Allow anonymous access to methods used by machines that may not have their -# certificates from us yet. -p, anonymous, nico/DiscoverMachine -p, anonymous, nico/ReportNicoScoutError -p, anonymous, nico/AttestQuote - -# Allow anonymous access to methods used by dpu-agent. As of 2023-09-28 there -# are probably a fair amount of agents across the environments that don't have a -# certificate and are not ready for strict enforcement. -p, anonymous, nico/FindInstanceByMachineID -p, anonymous, nico/GetManagedHostNetworkConfig -p, anonymous, nico/RecordDpuNetworkStatus - -# The client cert generated above has OU=site-admins in its subject. -# With group_from = "SubjectOU" in [auth.cli_certs], that becomes the -# principal "external-role/site-admins". Map it to a role and grant access. -g, external-role/site-admins, site-admin -p, site-admin, nico/* - -# Example of a restricted role: a cert with OU=viewers would only get -# read access to a handful of methods. -g, external-role/viewers, viewer -p, viewer, nico/Version -p, viewer, nico/GetMachine -p, viewer, nico/ListMachines -p, viewer, nico/GetInstance -p, viewer, nico/ListInstances - - -# Allow any certificate we trust to hit any NICo method. -# FIXME: This should be removed once we have more fine-grained rule coverage. -p, trusted-certificate, nico/* -``` - -The method names in the `nico/` column correspond to the gRPC -method names defined in the protobuf service definitions. Glob matching -(`*`) is supported. - -##### Full example: nico-api config with external admin certs - -```toml -[tls] -identity_pemfile_path = "/path/to/server.crt" -identity_keyfile_path = "/path/to/server.key" -root_cafile_path = "/path/to/internal-ca.crt" -admin_root_cafile_path = "/path/to/admin-ca.crt" - -[auth] -permissive_mode = false -casbin_policy_file = "/path/to/casbin-policy.csv" - -[auth.cli_certs] -required_equals = { "IssuerO" = "ExampleCo", "IssuerCN" = "ExampleCo NICo Admin CA" } -group_from = "SubjectOU" -username_from = "SubjectCN" - -[auth.trust] -spiffe_trust_domain = "nico.local" -spiffe_service_base_paths = [ - "/nico-system/sa/", - "/default/sa/", - "/elektra-site-agent/sa/", -] -spiffe_machine_base_path = "/nico-system/machine/" -additional_issuer_cns = [] -``` - -With this configuration, a client certificate with subject -`/O=ExampleCo/OU=site-admins/CN=jdoe` and issuer -`/O=ExampleCo/CN=ExampleCo NICo Admin CA` would: - -1. Pass the `required_equals` check (IssuerO and IssuerCN match) -2. Be assigned group `site-admins` (from SubjectOU) -3. Be identified as user `jdoe` (from SubjectCN) -4. Receive the principal `external-role/site-admins` -5. Be authorized according to whatever casbin policy rules match that - principal - - -You can see an example of a complete nico-api configuration file -[here](https://github.com/NVIDIA/ncx-infra-controller-core/blob/main/crates/api/src/cfg/test_data/full_config.toml) - -### Permissive mode - -Setting `permissive_mode = true` in the `[auth]` section causes the -authorization engine to **allow all requests**, even when the casbin -policy would deny them. Denied requests are logged with a warning -instead of being rejected: - -```toml -[auth] -permissive_mode = true -``` - -When permissive mode is active, nico-api logs messages like: - -``` -WARN The policy engine denied this request, but --auth-permissive-mode overrides it. +```sh +nico-admin-cli version ``` -**Use permissive mode only for:** +If it succeeds, the API URL, root CA, and client cert/key are all working. +`nico-admin-cli machine show --all` is a good first real query. -- Initial deployment and bring-up, before certificates are fully - configured -- Debugging authorization issues (enable temporarily, check logs, then - disable) -- Development environments +## mTLS and authorization -**Do not leave permissive mode enabled in production.** It bypasses all -authorization checks. Any client that can complete the TLS handshake -(or any client at all, if TLS is also disabled) can call any API method. +For generating client certificates, configuring the server-side TLS and +Casbin policy, and understanding how certificate fields map to authorization +roles, see [NICo mTLS and authorization](./nico-api-auth.md). -You can also set permissive mode via environment variable without -editing the config file: +--- -```sh -NICO_API_AUTH="{permissive_mode=true}" -``` +For the full command reference, see the [CLI manual index](https://github.com/NVIDIA/infra-controller/tree/main/docs/manuals/nico-admin-cli/index.md) diff --git a/docs/manuals/nico-admin-cli/admin.md b/docs/manuals/nico-admin-cli/admin.md new file mode 100644 index 0000000000..00f8547bc8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/admin.md @@ -0,0 +1,14 @@ +# CLI reference — Admin + +CLI and system utilities. + +For global flags and setup, see [the overview](./README.md) and [`setup.md`](./setup.md). For task-oriented sequences see [`workflows.md`](./workflows.md). + +| Command | Description | +|---|---| +| [`dev-env`](./commands/dev-env/dev-env.md) | Dev Env related handling. | +| [`generate-shell-complete`](./commands/generate-shell-complete/generate-shell-complete.md) | Generate shell autocomplete. Source the output of this command: `source <(nico-admin-cli generate-shell-complete bash)`. | +| [`jump`](./commands/jump/jump.md) | Broad search across multiple object types. | +| [`ping`](./commands/ping/ping.md) | Query the Version gRPC endpoint repeatedly printing how long it took and any failures. | +| [`ssh`](./commands/ssh/ssh.md) | SSH Util functions. | +| [`version`](./commands/version/version.md) | Print API server version. | diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-create.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-create.md new file mode 100644 index 0000000000..7c026150f5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-create.md @@ -0,0 +1,77 @@ +# `nico-admin-cli attestation measured-boot bundle create` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **create**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-create - Create a new +bundle with a given values, for a given profile ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle create** +\[**--state**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*NAME*\> \<*PROFILE_ID*\> \<*VALUES*\> + +## DESCRIPTION + +Create a new bundle with a given values, for a given profile ID. + +## OPTIONS + +**--state** *\* +The state for this bundle (default: active).\ + +\ +*Possible values:* + +- pending + +- active + +- obsolete + +- retired + +- revoked + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*NAME*\> +A human-readable name to give this bundle. + +\<*PROFILE_ID*\> +The profile ID of the profile to associate this bundle with. + +\<*VALUES*\> +Comma-separated list of {pcr_register:value,...} to associate with this +bundle. + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle create my-bundle 12345678-1234-5678-90ab-cdef01234567 0:abc123,7:def456 +nico-admin-cli attestation measured-boot bundle create my-bundle 12345678-1234-5678-90ab-cdef01234567 0:abc123 --state pending +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-delete.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-delete.md new file mode 100644 index 0000000000..e056a2340a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-delete.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation measured-boot bundle delete` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **delete**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-delete - Delete a bundle +based on ID + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle delete** +\[**--purge-journals**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*BUNDLE_ID*\> + +## DESCRIPTION + +Delete a bundle based on ID + +## OPTIONS + +**--purge-journals** +Also purge any journal records for this bundle. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*BUNDLE_ID*\> +The bundle ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle delete 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot bundle delete 12345678-1234-5678-90ab-cdef01234567 --purge-journals +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match-report.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match-report.md new file mode 100644 index 0000000000..cf226b035a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match-report.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot bundle find-closest-match report` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › [find-closest-match](./attestation-measured-boot-bundle-find-closest-match.md) › **report**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-find-closest-match-report - +The existing report ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle find-closest-match +report** \[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*ID*\> + +## DESCRIPTION + +The existing report ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +Report ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle find-closest-match report 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match.md new file mode 100644 index 0000000000..e1f3f4a858 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match.md @@ -0,0 +1,56 @@ +# `nico-admin-cli attestation measured-boot bundle find-closest-match` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **find-closest-match**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-find-closest-match - Get +closest bundle to a report. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle find-closest-match** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Get closest bundle to a report. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle find-closest-match report 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`report`](./attestation-measured-boot-bundle-find-closest-match-report.md) | The existing report ID. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-all.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-all.md new file mode 100644 index 0000000000..d8d5d078fd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-all.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation measured-boot bundle list all` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › [list](./attestation-measured-boot-bundle-list.md) › **all**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-list-all - List all +bundles + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle list all** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all bundles + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle list all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-machines.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-machines.md new file mode 100644 index 0000000000..3aabbb1082 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-machines.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot bundle list machines` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › [list](./attestation-measured-boot-bundle-list.md) › **machines**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-list-machines - List all +machines for a given bundle ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle list machines** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> + +## DESCRIPTION + +List all machines for a given bundle ID. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is bundle ID. + +**--is-name** +Explicitly say the identifier is a bundle name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The existing bundle ID or name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle list machines my-bundle +nico-admin-cli attestation measured-boot bundle list machines 12345678-1234-5678-90ab-cdef01234567 --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list.md new file mode 100644 index 0000000000..ed1351d315 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list.md @@ -0,0 +1,58 @@ +# `nico-admin-cli attestation measured-boot bundle list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-list - List bundles by +various ways. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +List bundles by various ways. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle list all +nico-admin-cli attestation measured-boot bundle list machines my-bundle +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`all`](./attestation-measured-boot-bundle-list-all.md) | List all bundles | +| [`machines`](./attestation-measured-boot-bundle-list-machines.md) | List all machines for a given bundle ID. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-rename.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-rename.md new file mode 100644 index 0000000000..e3cacb38d5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-rename.md @@ -0,0 +1,63 @@ +# `nico-admin-cli attestation measured-boot bundle rename` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **rename**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-rename - Rename a +bundle. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle rename** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> \<*NEW_BUNDLE_NAME*\> + +## DESCRIPTION + +Rename a bundle. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is bundle ID. + +**--is-name** +Explicitly say the identifier is a bundle name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The existing bundle ID or name. + +\<*NEW_BUNDLE_NAME*\> +The new bundle name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle rename old-name new-name +nico-admin-cli attestation measured-boot bundle rename 12345678-1234-5678-90ab-cdef01234567 new-name --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-set-state.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-set-state.md new file mode 100644 index 0000000000..f08cf5bf14 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-set-state.md @@ -0,0 +1,76 @@ +# `nico-admin-cli attestation measured-boot bundle set-state` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **set-state**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-set-state - Set a new +state for a bundle. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle set-state** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> \<*STATE*\> + +## DESCRIPTION + +Set a new state for a bundle. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is bundle ID. + +**--is-name** +Explicitly say the identifier is a bundle name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The bundle ID or name to update. + +\<*STATE*\> +The state to set for this bundle.\ + +\ +*Possible values:* + +- pending + +- active + +- obsolete + +- retired + +- revoked + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle set-state my-bundle obsolete +nico-admin-cli attestation measured-boot bundle set-state 12345678-1234-5678-90ab-cdef01234567 revoked --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-show.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-show.md new file mode 100644 index 0000000000..dce575cb4c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-show.md @@ -0,0 +1,61 @@ +# `nico-admin-cli attestation measured-boot bundle show` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [bundle](./attestation-measured-boot-bundle.md) › **show**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle-show - Show a bundle (or +all). + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle show** \[**--is-id**\] +\[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*IDENTIFIER*\] + +## DESCRIPTION + +Show a bundle (or all). + +## OPTIONS + +**--is-id** +Explicitly say the identifier is bundle ID. + +**--is-name** +Explicitly say the identifier is a bundle name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IDENTIFIER*\] +The optional bundle ID or name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot bundle show +nico-admin-cli attestation measured-boot bundle show 12345678-1234-5678-90ab-cdef01234567 --is-id +nico-admin-cli attestation measured-boot bundle show my-bundle --is-name +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle.md new file mode 100644 index 0000000000..e32990d0fd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle.md @@ -0,0 +1,55 @@ +# `nico-admin-cli attestation measured-boot bundle` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › **bundle**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-bundle - Work with golden +measurement bundles. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot bundle** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with golden measurement bundles. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./attestation-measured-boot-bundle-create.md) | Create a new bundle with a given values, for a given profile ID. | +| [`delete`](./attestation-measured-boot-bundle-delete.md) | Delete a bundle based on ID | +| [`rename`](./attestation-measured-boot-bundle-rename.md) | Rename a bundle. | +| [`set-state`](./attestation-measured-boot-bundle-set-state.md) | Set a new state for a bundle. | +| [`show`](./attestation-measured-boot-bundle-show.md) | Show a bundle (or all). | +| [`find-closest-match`](./attestation-measured-boot-bundle-find-closest-match.md) | Get closest bundle to a report. | +| [`list`](./attestation-measured-boot-bundle-list.md) | List bundles by various ways. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-delete.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-delete.md new file mode 100644 index 0000000000..dbe1c6de8e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-delete.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot journal delete` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [journal](./attestation-measured-boot-journal.md) › **delete**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-journal-delete - Delete a +journal entry. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot journal delete** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*JOURNAL_ID*\> + +## DESCRIPTION + +Delete a journal entry. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*JOURNAL_ID*\> +The journal ID to delete. + +## Examples + +```sh +nico-admin-cli attestation measured-boot journal delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-list.md new file mode 100644 index 0000000000..87c45285b9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-list.md @@ -0,0 +1,54 @@ +# `nico-admin-cli attestation measured-boot journal list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [journal](./attestation-measured-boot-journal.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-journal-list - List all journal +IDs and machines. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot journal list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*MACHINE_ID*\] + +## DESCRIPTION + +List all journal IDs and machines. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*MACHINE_ID*\] +List journal entries for a machine ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot journal list +nico-admin-cli attestation measured-boot journal list 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-promote.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-promote.md new file mode 100644 index 0000000000..b64a2d1ad2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-promote.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation measured-boot journal promote` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [journal](./attestation-measured-boot-journal.md) › **promote**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-journal-promote - Promote a +journal entry report to a bundle. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot journal promote** +\[**--pcr-registers**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*JOURNAL_ID*\> + +## DESCRIPTION + +Promote a journal entry report to a bundle. + +## OPTIONS + +**--pcr-registers** *\* +Select specific PCR range(s) to use for the promoted bundle. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*JOURNAL_ID*\> +The journal entry ID to promote a report from. + +## Examples + +```sh +nico-admin-cli attestation measured-boot journal promote 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot journal promote 12345678-1234-5678-90ab-cdef01234567 --pcr-registers 0,7,11-14 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-show.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-show.md new file mode 100644 index 0000000000..472b02265f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal-show.md @@ -0,0 +1,54 @@ +# `nico-admin-cli attestation measured-boot journal show` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [journal](./attestation-measured-boot-journal.md) › **show**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-journal-show - Show a journal +entry by ID, or all. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot journal show** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*JOURNAL_ID*\] + +## DESCRIPTION + +Show a journal entry by ID, or all. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*JOURNAL_ID*\] +The optional journal entry ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot journal show +nico-admin-cli attestation measured-boot journal show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal.md new file mode 100644 index 0000000000..51f64459db --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-journal.md @@ -0,0 +1,52 @@ +# `nico-admin-cli attestation measured-boot journal` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › **journal**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-journal - Work with machine +meausrement journals + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot journal** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with machine meausrement journals + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`delete`](./attestation-measured-boot-journal-delete.md) | Delete a journal entry. | +| [`show`](./attestation-measured-boot-journal-show.md) | Show a journal entry by ID, or all. | +| [`list`](./attestation-measured-boot-journal-list.md) | List all journal IDs and machines. | +| [`promote`](./attestation-measured-boot-journal-promote.md) | Promote a journal entry report to a bundle. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-attest.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-attest.md new file mode 100644 index 0000000000..2221f9fff6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-attest.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation measured-boot machine attest` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [machine](./attestation-measured-boot-machine.md) › **attest**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-machine-attest - Send +measurements for a machine. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot machine attest** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> \<*VALUES*\> + +## DESCRIPTION + +Send measurements for a machine. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine ID of the machine to associate this report with. + +\<*VALUES*\> +Comma-separated list of {pcr_register:value,...} to associate with this +report. + +## Examples + +```sh +nico-admin-cli attestation measured-boot machine attest 12345678-1234-5678-90ab-cdef01234567 0:abc123,7:def456 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-list.md new file mode 100644 index 0000000000..817b086b81 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-list.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation measured-boot machine list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [machine](./attestation-measured-boot-machine.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-machine-list - List all +machines + their info. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot machine list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all machines + their info. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot machine list +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-show.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-show.md new file mode 100644 index 0000000000..2ea7be44a1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine-show.md @@ -0,0 +1,54 @@ +# `nico-admin-cli attestation measured-boot machine show` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [machine](./attestation-measured-boot-machine.md) › **show**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-machine-show - Get all info +about a machine. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot machine show** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*MACHINE_ID*\] + +## DESCRIPTION + +Get all info about a machine. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*MACHINE_ID*\] +The machine ID to show. + +## Examples + +```sh +nico-admin-cli attestation measured-boot machine show +nico-admin-cli attestation measured-boot machine show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine.md new file mode 100644 index 0000000000..ded0e57889 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-machine.md @@ -0,0 +1,51 @@ +# `nico-admin-cli attestation measured-boot machine` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › **machine**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-machine - Work with +mock-machine entries + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot machine** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with mock-machine entries + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`attest`](./attestation-measured-boot-machine-attest.md) | Send measurements for a machine. | +| [`show`](./attestation-measured-boot-machine-show.md) | Get all info about a machine. | +| [`list`](./attestation-measured-boot-machine-list.md) | List all machines + their info. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-create.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-create.md new file mode 100644 index 0000000000..bdc7c28bb9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-create.md @@ -0,0 +1,63 @@ +# `nico-admin-cli attestation measured-boot profile create` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › **create**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-create - Create a new +profile with a given config. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile create** +\[**--extra-attrs**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*NAME*\> \<*VENDOR*\> \<*PRODUCT*\> + +## DESCRIPTION + +Create a new profile with a given config. + +## OPTIONS + +**--extra-attrs** *\* +A comma-separated list of additional k:v,k:v,... attributes to set. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*NAME*\> +Every profile gets a name. + +\<*VENDOR*\> +The hardware vendor (e.g. dell). + +\<*PRODUCT*\> +The hardware product (e.g. poweredge_r750). + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile create my-profile dell poweredge_r750 +nico-admin-cli attestation measured-boot profile create my-profile dell poweredge_r750 --extra-attrs region:us-west,rack:r1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-delete.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-delete.md new file mode 100644 index 0000000000..3ed09a063a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-delete.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot profile delete` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › **delete**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-delete - Delete a +profile by ID or name. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile delete** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> + +## DESCRIPTION + +Delete a profile by ID or name. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is profile ID. + +**--is-name** +Explicitly say the identifier is a profile name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The profile ID or name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile delete my-profile +nico-admin-cli attestation measured-boot profile delete 12345678-1234-5678-90ab-cdef01234567 --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-all.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-all.md new file mode 100644 index 0000000000..c69adb7b2b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-all.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation measured-boot profile list all` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › [list](./attestation-measured-boot-profile-list.md) › **all**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-list-all - List all +profiles + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile list all** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all profiles + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile list all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-bundles.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-bundles.md new file mode 100644 index 0000000000..1e4be2b927 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-bundles.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot profile list bundles` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › [list](./attestation-measured-boot-profile-list.md) › **bundles**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-list-bundles - List all +bundles for a given profile ID or name. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile list bundles** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> + +## DESCRIPTION + +List all bundles for a given profile ID or name. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is profile ID. + +**--is-name** +Explicitly say the identifier is a profile name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The profile ID or name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile list bundles my-profile +nico-admin-cli attestation measured-boot profile list bundles 12345678-1234-5678-90ab-cdef01234567 --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-machines.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-machines.md new file mode 100644 index 0000000000..b983727edb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list-machines.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot profile list machines` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › [list](./attestation-measured-boot-profile-list.md) › **machines**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-list-machines - List +all machines for a given profile ID or name. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile list machines** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> + +## DESCRIPTION + +List all machines for a given profile ID or name. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is profile ID. + +**--is-name** +Explicitly say the identifier is a profile name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The profile ID or name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile list machines my-profile +nico-admin-cli attestation measured-boot profile list machines 12345678-1234-5678-90ab-cdef01234567 --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list.md new file mode 100644 index 0000000000..c7155db229 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-list.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot profile list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-list - List profiles by +various ways. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +List profiles by various ways. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile list all +nico-admin-cli attestation measured-boot profile list bundles my-profile +nico-admin-cli attestation measured-boot profile list machines my-profile +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`all`](./attestation-measured-boot-profile-list-all.md) | List all profiles | +| [`bundles`](./attestation-measured-boot-profile-list-bundles.md) | List all bundles for a given profile ID or name. | +| [`machines`](./attestation-measured-boot-profile-list-machines.md) | List all machines for a given profile ID or name. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-rename.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-rename.md new file mode 100644 index 0000000000..69a39fc7c7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-rename.md @@ -0,0 +1,63 @@ +# `nico-admin-cli attestation measured-boot profile rename` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › **rename**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-rename - Rename a +profile. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile rename** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> \<*NEW_PROFILE_NAME*\> + +## DESCRIPTION + +Rename a profile. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is profile ID. + +**--is-name** +Explicitly say the identifier is a profile name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +The existing profile ID or name. + +\<*NEW_PROFILE_NAME*\> +The new profile name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile rename old-name new-name +nico-admin-cli attestation measured-boot profile rename 12345678-1234-5678-90ab-cdef01234567 new-name --is-id +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-show.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-show.md new file mode 100644 index 0000000000..9d6674d9be --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile-show.md @@ -0,0 +1,61 @@ +# `nico-admin-cli attestation measured-boot profile show` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [profile](./attestation-measured-boot-profile.md) › **show**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile-show - Show profiles in +different ways. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile show** +\[**--is-id**\] \[**--is-name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*IDENTIFIER*\] + +## DESCRIPTION + +Show profiles in different ways. + +## OPTIONS + +**--is-id** +Explicitly say the identifier is profile ID. + +**--is-name** +Explicitly say the identifier is a profile name. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IDENTIFIER*\] +The optional profile ID or name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot profile show +nico-admin-cli attestation measured-boot profile show 12345678-1234-5678-90ab-cdef01234567 --is-id +nico-admin-cli attestation measured-boot profile show my-profile --is-name +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile.md new file mode 100644 index 0000000000..23ccdeaa14 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-profile.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot profile` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › **profile**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-profile - Work with machine +hardware profiles + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot profile** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with machine hardware profiles + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./attestation-measured-boot-profile-create.md) | Create a new profile with a given config. | +| [`delete`](./attestation-measured-boot-profile-delete.md) | Delete a profile by ID or name. | +| [`rename`](./attestation-measured-boot-profile-rename.md) | Rename a profile. | +| [`show`](./attestation-measured-boot-profile-show.md) | Show profiles in different ways. | +| [`list`](./attestation-measured-boot-profile-list.md) | List profiles by various ways. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-create.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-create.md new file mode 100644 index 0000000000..8c644413dd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-create.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation measured-boot report create` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **create**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-create - Create a new +report with a given config. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report create** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> \<*VALUES*\> + +## DESCRIPTION + +Create a new report with a given config. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine ID of the machine to associate this report with. + +\<*VALUES*\> +Comma-separated list of {pcr_register:value,...} to associate with this +report. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report create 12345678-1234-5678-90ab-cdef01234567 0:abc123,7:def456 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-delete.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-delete.md new file mode 100644 index 0000000000..c9251a1774 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-delete.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot report delete` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **delete**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-delete - Delete a report +by ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report delete** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*REPORT_ID*\> + +## DESCRIPTION + +Delete a report by ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*REPORT_ID*\> +The report ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list-all.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list-all.md new file mode 100644 index 0000000000..75175c023f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list-all.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation measured-boot report list all` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › [list](./attestation-measured-boot-report-list.md) › **all**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-list-all - List all +reports + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report list all** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all reports + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot report list all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list-machines.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list-machines.md new file mode 100644 index 0000000000..4dcf753b9f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list-machines.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot report list machines` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › [list](./attestation-measured-boot-report-list.md) › **machines**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-list-machines - List all +reports for a given machine ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report list machines** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> + +## DESCRIPTION + +List all reports for a given machine ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report list machines 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list.md new file mode 100644 index 0000000000..6a7b367e4d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-list.md @@ -0,0 +1,58 @@ +# `nico-admin-cli attestation measured-boot report list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-list - List reports by +various ways. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +List reports by various ways. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot report list all +nico-admin-cli attestation measured-boot report list machines 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`all`](./attestation-measured-boot-report-list-all.md) | List all reports | +| [`machines`](./attestation-measured-boot-report-list-machines.md) | List all reports for a given machine ID. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-match.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-match.md new file mode 100644 index 0000000000..d7d1615267 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-match.md @@ -0,0 +1,52 @@ +# `nico-admin-cli attestation measured-boot report match` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **match**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-match - Match reports +with the provided PCR register values. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report match** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*VALUES*\> + +## DESCRIPTION + +Match reports with the provided PCR register values. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*VALUES*\> +Comma-separated list of {pcr_register:value,...} to match on. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report match 0:abc123,7:def456 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-promote.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-promote.md new file mode 100644 index 0000000000..51f01ca7eb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-promote.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation measured-boot report promote` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **promote**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-promote - Promote a +specific journal entry to an active bundle + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report promote** +\[**--pcr-registers**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*REPORT_ID*\> + +## DESCRIPTION + +Promote a specific journal entry to an active bundle + +## OPTIONS + +**--pcr-registers** *\* +Select a specific PCR range to use for the promoted bundle. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*REPORT_ID*\> +The report ID to promote. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report promote 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot report promote 12345678-1234-5678-90ab-cdef01234567 --pcr-registers 0,7,11-14 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-revoke.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-revoke.md new file mode 100644 index 0000000000..48163d8113 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-revoke.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation measured-boot report revoke` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **revoke**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-revoke - Mark a specific +journal entry as a revoked bundle. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report revoke** +\[**--pcr-registers**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*REPORT_ID*\> + +## DESCRIPTION + +Mark a specific journal entry as a revoked bundle. + +## OPTIONS + +**--pcr-registers** *\* +Select a specific PCR range to use for the revoked bundle. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*REPORT_ID*\> +The report ID to revoke. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report revoke 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot report revoke 12345678-1234-5678-90ab-cdef01234567 --pcr-registers 0,7,11-14 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-all.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-all.md new file mode 100644 index 0000000000..241bd4fc51 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-all.md @@ -0,0 +1,43 @@ +# `nico-admin-cli attestation measured-boot report show all` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › [show](./attestation-measured-boot-report-show.md) › **all**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-show-all - Show all +reports. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report show all** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show all reports. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-id.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-id.md new file mode 100644 index 0000000000..121edf0076 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-id.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot report show id` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › [show](./attestation-measured-boot-report-show.md) › **id**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-show-id - Show a report +ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report show id** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*REPORT_ID*\> + +## DESCRIPTION + +Show a report ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*REPORT_ID*\> +The report ID. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report show id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-machine.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-machine.md new file mode 100644 index 0000000000..ec7417fc31 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show-machine.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot report show machine` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › [show](./attestation-measured-boot-report-show.md) › **machine**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-show-machine - Show +reports for a machine. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report show machine** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> + +## DESCRIPTION + +Show reports for a machine. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The profile name. + +## Examples + +```sh +nico-admin-cli attestation measured-boot report show machine 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show.md new file mode 100644 index 0000000000..565982b038 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report-show.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot report show` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [report](./attestation-measured-boot-report.md) › **show**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report-show - Show reports in +different ways. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report show** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Show reports in different ways. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot report show all +nico-admin-cli attestation measured-boot report show id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot report show machine 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`id`](./attestation-measured-boot-report-show-id.md) | Show a report ID. | +| [`machine`](./attestation-measured-boot-report-show-machine.md) | Show reports for a machine. | +| [`all`](./attestation-measured-boot-report-show-all.md) | Show all reports. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report.md new file mode 100644 index 0000000000..7b2c4c6ead --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-report.md @@ -0,0 +1,55 @@ +# `nico-admin-cli attestation measured-boot report` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › **report**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-report - Work with machine +reports + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with machine reports + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./attestation-measured-boot-report-create.md) | Create a new report with a given config. | +| [`delete`](./attestation-measured-boot-report-delete.md) | Delete a report by ID. | +| [`promote`](./attestation-measured-boot-report-promote.md) | Promote a specific journal entry to an active bundle | +| [`revoke`](./attestation-measured-boot-report-revoke.md) | Mark a specific journal entry as a revoked bundle. | +| [`show`](./attestation-measured-boot-report-show.md) | Show reports in different ways. | +| [`list`](./attestation-measured-boot-report-list.md) | List reports by various ways. | +| [`match`](./attestation-measured-boot-report-match.md) | Match reports with the provided PCR register values. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-export.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-export.md new file mode 100644 index 0000000000..7f00808a39 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-export.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot site export` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › **export**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-export - Export a site to +an export file. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site export** \[**--path**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Export a site to an export file. + +## OPTIONS + +**--path** *\* +An optional path to write the file to. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site export +nico-admin-cli attestation measured-boot site export --path ./site.json +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-import.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-import.md new file mode 100644 index 0000000000..3b9f71850f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-import.md @@ -0,0 +1,52 @@ +# `nico-admin-cli attestation measured-boot site import` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › **import**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-import - Import a site +from an export file. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site import** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*PATH*\> + +## DESCRIPTION + +Import a site from an export file. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*PATH*\> +The path of the input JSON file. + +## Examples + +```sh +nico-admin-cli attestation measured-boot site import ./site.json +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-approve.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-approve.md new file mode 100644 index 0000000000..5997a9ffa7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-approve.md @@ -0,0 +1,71 @@ +# `nico-admin-cli attestation measured-boot site trusted-machine approve` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-machine](./attestation-measured-boot-site-trusted-machine.md) › **approve**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-machine-approve - +Approve a trusted machine for auto-promoting its measurements. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-machine +approve** \[**--pcr-registers**\] \[**--comments**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*APPROVAL_TYPE*\> + +## DESCRIPTION + +Approve a trusted machine for auto-promoting its measurements. + +## OPTIONS + +**--pcr-registers** *\* +Specific PCR register selector. All if unset. + +**--comments** *\* +Optional comments about this approval. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine-id to approve (or \* for all). + +\<*APPROVAL_TYPE*\> +Whether to set \`oneshot\` or \`persist\`.\ + +\ +*Possible values:* + +- oneshot + +- persist + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-machine approve 12345678-1234-5678-90ab-cdef01234567 oneshot +nico-admin-cli attestation measured-boot site trusted-machine approve '*' persist --pcr-registers 0,7 --comments "trusted fleet" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-list.md new file mode 100644 index 0000000000..885cca4b66 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-list.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation measured-boot site trusted-machine list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-machine](./attestation-measured-boot-site-trusted-machine.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-machine-list - +List all active machine approvals. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-machine list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all active machine approvals. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-machine list +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove-by-approval-id.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove-by-approval-id.md new file mode 100644 index 0000000000..7f84c3eafa --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove-by-approval-id.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot site trusted-machine remove by-approval-id` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-machine](./attestation-measured-boot-site-trusted-machine.md) › [remove](./attestation-measured-boot-site-trusted-machine-remove.md) › **by-approval-id**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-machine-remove-by-approval-id - +Remove by approval ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-machine remove +by-approval-id** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*APPROVAL_ID*\> + +## DESCRIPTION + +Remove by approval ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*APPROVAL_ID*\> +The approval-id to remove. + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-machine remove by-approval-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove-by-machine-id.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove-by-machine-id.md new file mode 100644 index 0000000000..e5bd0379b2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove-by-machine-id.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot site trusted-machine remove by-machine-id` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-machine](./attestation-measured-boot-site-trusted-machine.md) › [remove](./attestation-measured-boot-site-trusted-machine-remove.md) › **by-machine-id**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-machine-remove-by-machine-id - +Remove by machine ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-machine remove +by-machine-id** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Remove by machine ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine-id to remove. + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-machine remove by-machine-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove.md new file mode 100644 index 0000000000..3edd5cafe2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine-remove.md @@ -0,0 +1,58 @@ +# `nico-admin-cli attestation measured-boot site trusted-machine remove` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-machine](./attestation-measured-boot-site-trusted-machine.md) › **remove**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-machine-remove - +Remove a trusted machine approval. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-machine remove** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Remove a trusted machine approval. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-machine remove by-approval-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot site trusted-machine remove by-machine-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`by-approval-id`](./attestation-measured-boot-site-trusted-machine-remove-by-approval-id.md) | Remove by approval ID. | +| [`by-machine-id`](./attestation-measured-boot-site-trusted-machine-remove-by-machine-id.md) | Remove by machine ID. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine.md new file mode 100644 index 0000000000..0c24348621 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-machine.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot site trusted-machine` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › **trusted-machine**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-machine - Managed +trusted machines. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-machine** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Managed trusted machines. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-machine approve 12345678-1234-5678-90ab-cdef01234567 oneshot +nico-admin-cli attestation measured-boot site trusted-machine list +nico-admin-cli attestation measured-boot site trusted-machine remove by-machine-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`approve`](./attestation-measured-boot-site-trusted-machine-approve.md) | Approve a trusted machine for auto-promoting its measurements. | +| [`remove`](./attestation-measured-boot-site-trusted-machine-remove.md) | Remove a trusted machine approval. | +| [`list`](./attestation-measured-boot-site-trusted-machine-list.md) | List all active machine approvals. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-approve.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-approve.md new file mode 100644 index 0000000000..a9633619ef --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-approve.md @@ -0,0 +1,71 @@ +# `nico-admin-cli attestation measured-boot site trusted-profile approve` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-profile](./attestation-measured-boot-site-trusted-profile.md) › **approve**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-profile-approve - +Allow auto-promoting of measurements from machines matching a profile. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-profile +approve** \[**--pcr-registers**\] \[**--comments**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*PROFILE_ID*\> +\<*APPROVAL_TYPE*\> + +## DESCRIPTION + +Allow auto-promoting of measurements from machines matching a profile. + +## OPTIONS + +**--pcr-registers** *\* +Specific PCR register selector. All if unset. + +**--comments** *\* +Optional comments about this approval. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*PROFILE_ID*\> +The profile-id to approve. + +\<*APPROVAL_TYPE*\> +Whether to set \`oneshot\` or \`persist\`.\ + +\ +*Possible values:* + +- oneshot + +- persist + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-profile approve 12345678-1234-5678-90ab-cdef01234567 oneshot +nico-admin-cli attestation measured-boot site trusted-profile approve 12345678-1234-5678-90ab-cdef01234567 persist --pcr-registers 0,7 --comments "trusted SKU" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-list.md new file mode 100644 index 0000000000..16641ccad2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-list.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation measured-boot site trusted-profile list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-profile](./attestation-measured-boot-site-trusted-profile.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-profile-list - +List all active profile approvals. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-profile list** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all active profile approvals. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-profile list +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove-by-approval-id.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove-by-approval-id.md new file mode 100644 index 0000000000..6685b85c15 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove-by-approval-id.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot site trusted-profile remove by-approval-id` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-profile](./attestation-measured-boot-site-trusted-profile.md) › [remove](./attestation-measured-boot-site-trusted-profile-remove.md) › **by-approval-id**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-profile-remove-by-approval-id - +Remove by approval ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-profile remove +by-approval-id** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*APPROVAL_ID*\> + +## DESCRIPTION + +Remove by approval ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*APPROVAL_ID*\> +The approval-id to remove. + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-profile remove by-approval-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove-by-profile-id.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove-by-profile-id.md new file mode 100644 index 0000000000..7653177c6a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove-by-profile-id.md @@ -0,0 +1,53 @@ +# `nico-admin-cli attestation measured-boot site trusted-profile remove by-profile-id` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-profile](./attestation-measured-boot-site-trusted-profile.md) › [remove](./attestation-measured-boot-site-trusted-profile-remove.md) › **by-profile-id**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-profile-remove-by-profile-id - +Remove by profile ID. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-profile remove +by-profile-id** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*PROFILE_ID*\> + +## DESCRIPTION + +Remove by profile ID. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*PROFILE_ID*\> +The profile-id to remove. + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-profile remove by-profile-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove.md new file mode 100644 index 0000000000..6f3c9d2038 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile-remove.md @@ -0,0 +1,58 @@ +# `nico-admin-cli attestation measured-boot site trusted-profile remove` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › [trusted-profile](./attestation-measured-boot-site-trusted-profile.md) › **remove**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-profile-remove - +Remove a trusted profile approval. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-profile remove** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Remove a trusted profile approval. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-profile remove by-approval-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli attestation measured-boot site trusted-profile remove by-profile-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`by-approval-id`](./attestation-measured-boot-site-trusted-profile-remove-by-approval-id.md) | Remove by approval ID. | +| [`by-profile-id`](./attestation-measured-boot-site-trusted-profile-remove-by-profile-id.md) | Remove by profile ID. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile.md new file mode 100644 index 0000000000..60cfe268ae --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site-trusted-profile.md @@ -0,0 +1,60 @@ +# `nico-admin-cli attestation measured-boot site trusted-profile` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › [site](./attestation-measured-boot-site.md) › **trusted-profile**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site-trusted-profile - Managed +trusted profiles. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site trusted-profile** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Managed trusted profiles. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation measured-boot site trusted-profile approve 12345678-1234-5678-90ab-cdef01234567 persist +nico-admin-cli attestation measured-boot site trusted-profile list +nico-admin-cli attestation measured-boot site trusted-profile remove by-profile-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`approve`](./attestation-measured-boot-site-trusted-profile-approve.md) | Allow auto-promoting of measurements from machines matching a profile. | +| [`remove`](./attestation-measured-boot-site-trusted-profile-remove.md) | Remove a trusted profile approval. | +| [`list`](./attestation-measured-boot-site-trusted-profile-list.md) | List all active profile approvals. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site.md new file mode 100644 index 0000000000..09802bc977 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-site.md @@ -0,0 +1,52 @@ +# `nico-admin-cli attestation measured-boot site` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [measured-boot](./attestation-measured-boot.md) › **site**_ + +## NAME + +nico-admin-cli-attestation-measured-boot-site - Work with site-wide +things. + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot site** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with site-wide things. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`import`](./attestation-measured-boot-site-import.md) | Import a site from an export file. | +| [`export`](./attestation-measured-boot-site-export.md) | Export a site to an export file. | +| [`trusted-machine`](./attestation-measured-boot-site-trusted-machine.md) | Managed trusted machines. | +| [`trusted-profile`](./attestation-measured-boot-site-trusted-profile.md) | Managed trusted profiles. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot.md new file mode 100644 index 0000000000..e8933781cb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot.md @@ -0,0 +1,55 @@ +# `nico-admin-cli attestation measured-boot` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › **measured-boot**_ + +## NAME + +nico-admin-cli-attestation-measured-boot - Work with measured boot data +(bundles, journals, reports, profiles, site). + +## SYNOPSIS + +**nico-admin-cli attestation measured-boot** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Work with measured boot data (bundles, journals, reports, profiles, +site). + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`bundle`](./attestation-measured-boot-bundle.md) | Work with golden measurement bundles. | +| [`journal`](./attestation-measured-boot-journal.md) | Work with machine meausrement journals | +| [`report`](./attestation-measured-boot-report.md) | Work with machine reports | +| [`machine`](./attestation-measured-boot-machine.md) | Work with mock-machine entries | +| [`profile`](./attestation-measured-boot-profile.md) | Work with machine hardware profiles | +| [`site`](./attestation-measured-boot-site.md) | Work with site-wide things. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-cancel.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-cancel.md new file mode 100644 index 0000000000..21616777e7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-cancel.md @@ -0,0 +1,52 @@ +# `nico-admin-cli attestation spdm cancel` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [spdm](./attestation-spdm.md) › **cancel**_ + +## NAME + +nico-admin-cli-attestation-spdm-cancel - Cancel attestation for a given +machine id + +## SYNOPSIS + +**nico-admin-cli attestation spdm cancel** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Cancel attestation for a given machine id + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine ID + +## Examples + +```sh +nico-admin-cli attestation spdm cancel 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-get.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-get.md new file mode 100644 index 0000000000..00b32a8602 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-get.md @@ -0,0 +1,52 @@ +# `nico-admin-cli attestation spdm get` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [spdm](./attestation-spdm.md) › **get**_ + +## NAME + +nico-admin-cli-attestation-spdm-get - Get SPDM attestation details for a +given machine id + +## SYNOPSIS + +**nico-admin-cli attestation spdm get** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Get SPDM attestation details for a given machine id + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine ID + +## Examples + +```sh +nico-admin-cli attestation spdm get 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-list.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-list.md new file mode 100644 index 0000000000..51a6bf53f6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-list.md @@ -0,0 +1,63 @@ +# `nico-admin-cli attestation spdm list` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [spdm](./attestation-spdm.md) › **list**_ + +## NAME + +nico-admin-cli-attestation-spdm-list - List SPDM attestation machine +statuses + +## SYNOPSIS + +**nico-admin-cli attestation spdm list** \[**--machine-id**\] +\[**--selector**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +List SPDM attestation machine statuses + +## OPTIONS + +**--machine-id** *\* +Machine ID + +**--selector** *\* +Filter attestation machines by selector\ + +\ +*Possible values:* + +- in-progress + +- unsuccessful + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli attestation spdm list 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-trigger.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-trigger.md new file mode 100644 index 0000000000..23eb9d6d30 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm-trigger.md @@ -0,0 +1,57 @@ +# `nico-admin-cli attestation spdm trigger` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › [spdm](./attestation-spdm.md) › **trigger**_ + +## NAME + +nico-admin-cli-attestation-spdm-trigger - Trigger attestation for a +given machine with id + +## SYNOPSIS + +**nico-admin-cli attestation spdm trigger** +\<**--redfish-timeout-secs**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Trigger attestation for a given machine with id + +## OPTIONS + +**--redfish-timeout-secs** *\* +Timeout in seconds for Redfish operations while triggering attestation +(passed to carbide-api) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine ID + +## Examples + +```sh +nico-admin-cli attestation spdm trigger 12345678-1234-5678-90ab-cdef01234567 --redfish-timeout-secs 60 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm.md new file mode 100644 index 0000000000..6fa45ade8e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation-spdm.md @@ -0,0 +1,51 @@ +# `nico-admin-cli attestation spdm` + +_[Hardware commands](../../hardware.md) › [attestation](./attestation.md) › **spdm**_ + +## NAME + +nico-admin-cli-attestation-spdm - Perform SPDM attestation + +## SYNOPSIS + +**nico-admin-cli attestation spdm** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Perform SPDM attestation + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`cancel`](./attestation-spdm-cancel.md) | Cancel attestation for a given machine id | +| [`get`](./attestation-spdm-get.md) | Get SPDM attestation details for a given machine id | +| [`list`](./attestation-spdm-list.md) | List SPDM attestation machine statuses | +| [`trigger`](./attestation-spdm-trigger.md) | Trigger attestation for a given machine with id | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/attestation/attestation.md b/docs/manuals/nico-admin-cli/commands/attestation/attestation.md new file mode 100644 index 0000000000..ad5c592106 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/attestation/attestation.md @@ -0,0 +1,49 @@ +# `nico-admin-cli attestation` + +_[Hardware commands](../../hardware.md) › **attestation**_ + +## NAME + +nico-admin-cli-attestation - MeasuredBoot or SPDM attestations + +## SYNOPSIS + +**nico-admin-cli attestation** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +MeasuredBoot or SPDM attestations + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`spdm`](./attestation-spdm.md) | Perform SPDM attestation | +| [`measured-boot`](./attestation-measured-boot.md) | Work with measured boot data (bundles, journals, reports, profiles, site). | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-admin-power-control.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-admin-power-control.md new file mode 100644 index 0000000000..ff9ba4f044 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-admin-power-control.md @@ -0,0 +1,73 @@ +# `nico-admin-cli bmc-machine admin-power-control` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **admin-power-control**_ + +## NAME + +nico-admin-cli-bmc-machine-admin-power-control - Redfish Power Control + +## SYNOPSIS + +**nico-admin-cli bmc-machine admin-power-control** \<**--machine**\> +\<**--action**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Redfish Power Control + +## OPTIONS + +**--machine** *\* +ID of the machine to reboot + +**--action** *\* +Power control action\ + +\ +*Possible values:* + +- on + +- graceful-shutdown + +- force-off + +- graceful-restart + +- force-restart + +- ac-powercycle + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine admin-power-control --machine 12345678-1234-5678-90ab-cdef01234567 --action on +nico-admin-cli bmc-machine admin-power-control --machine 12345678-1234-5678-90ab-cdef01234567 --action graceful-shutdown +nico-admin-cli bmc-machine admin-power-control --machine 12345678-1234-5678-90ab-cdef01234567 --action force-off +nico-admin-cli bmc-machine admin-power-control --machine 12345678-1234-5678-90ab-cdef01234567 --action graceful-restart +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-bmc-reset.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-bmc-reset.md new file mode 100644 index 0000000000..6cbf119297 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-bmc-reset.md @@ -0,0 +1,57 @@ +# `nico-admin-cli bmc-machine bmc-reset` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **bmc-reset**_ + +## NAME + +nico-admin-cli-bmc-machine-bmc-reset - Reset BMC + +## SYNOPSIS + +**nico-admin-cli bmc-machine bmc-reset** \<**--machine**\> +\[**-u**\|**--use-ipmitool**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Reset BMC + +## OPTIONS + +**--machine** *\* +ID of the machine to reboot + +**-u**, **--use-ipmitool** +Use ipmitool instead of Redfish to reset the BMC. ipmitool bmc reset +requests may be silently ignored if the BMC is in lockdown mode. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine bmc-reset --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli bmc-machine bmc-reset --machine 12345678-1234-5678-90ab-cdef01234567 --use-ipmitool +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-create-bmc-user.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-create-bmc-user.md new file mode 100644 index 0000000000..0e0f6402fe --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-create-bmc-user.md @@ -0,0 +1,81 @@ +# `nico-admin-cli bmc-machine create-bmc-user` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **create-bmc-user**_ + +## NAME + +nico-admin-cli-bmc-machine-create-bmc-user + +## SYNOPSIS + +**nico-admin-cli bmc-machine create-bmc-user** +\[**-i**\|**--ip-address**\] \[**--mac-address**\] +\[**-m**\|**--machine**\] \<**-u**\|**--username**\> +\<**-p**\|**--password**\> \[**-r**\|**--role-id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +## OPTIONS + +**-i**, **--ip-address** *\* +IP of the BMC where we want to create a new user + +**--mac-address** *\* +MAC of the BMC where we want to create a new user + +**-m**, **--machine** *\* +ID of the machine where we want to create a new user + +**-u**, **--username** *\* +Username of new BMC account + +**-p**, **--password** *\* +Password of new BMC account + +**-r**, **--role-id** *\* +Role of new BMC account (default: administrator)\ + +\ +*Possible values:* + +- administrator + +- operator + +- readonly + +- noaccess + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine create-bmc-user --machine 12345678-1234-5678-90ab-cdef01234567 --username admin --password mynewpassword +nico-admin-cli bmc-machine create-bmc-user --ip-address 192.0.2.20 --username admin --password mynewpassword +nico-admin-cli bmc-machine create-bmc-user --mac-address 00:11:22:33:44:55 --username admin --password mynewpassword +nico-admin-cli bmc-machine create-bmc-user --machine 12345678-1234-5678-90ab-cdef01234567 --username admin --password mynewpassword --role-id readonly +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-delete-bmc-user.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-delete-bmc-user.md new file mode 100644 index 0000000000..69e85284d9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-delete-bmc-user.md @@ -0,0 +1,62 @@ +# `nico-admin-cli bmc-machine delete-bmc-user` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **delete-bmc-user**_ + +## NAME + +nico-admin-cli-bmc-machine-delete-bmc-user + +## SYNOPSIS + +**nico-admin-cli bmc-machine delete-bmc-user** +\[**-i**\|**--ip-address**\] \[**--mac-address**\] +\[**-m**\|**--machine**\] \<**-u**\|**--username**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +## OPTIONS + +**-i**, **--ip-address** *\* +IP of the BMC where we want to delete a user + +**--mac-address** *\* +MAC of the BMC where we want to delete a user + +**-m**, **--machine** *\* +ID of the machine where we want to delete a user + +**-u**, **--username** *\* +Username of BMC account to delete + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine delete-bmc-user --machine 12345678-1234-5678-90ab-cdef01234567 --username admin +nico-admin-cli bmc-machine delete-bmc-user --ip-address 192.0.2.20 --username admin +nico-admin-cli bmc-machine delete-bmc-user --mac-address 00:11:22:33:44:55 --username admin +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-enable-infinite-boot.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-enable-infinite-boot.md new file mode 100644 index 0000000000..541dce5fd6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-enable-infinite-boot.md @@ -0,0 +1,56 @@ +# `nico-admin-cli bmc-machine enable-infinite-boot` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **enable-infinite-boot**_ + +## NAME + +nico-admin-cli-bmc-machine-enable-infinite-boot - Enable infinite boot + +## SYNOPSIS + +**nico-admin-cli bmc-machine enable-infinite-boot** \<**--machine**\> +\[**-r**\|**--reboot**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Enable infinite boot + +## OPTIONS + +**--machine** *\* +ID of the machine to enable/query infinite boot + +**-r**, **--reboot** +Issue reboot to apply BIOS change + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine enable-infinite-boot --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli bmc-machine enable-infinite-boot --machine 12345678-1234-5678-90ab-cdef01234567 --reboot +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-is-infinite-boot-enabled.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-is-infinite-boot-enabled.md new file mode 100644 index 0000000000..efa9448df3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-is-infinite-boot-enabled.md @@ -0,0 +1,56 @@ +# `nico-admin-cli bmc-machine is-infinite-boot-enabled` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **is-infinite-boot-enabled**_ + +## NAME + +nico-admin-cli-bmc-machine-is-infinite-boot-enabled - Check if infinite +boot is enabled + +## SYNOPSIS + +**nico-admin-cli bmc-machine is-infinite-boot-enabled** +\<**--machine**\> \[**-r**\|**--reboot**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Check if infinite boot is enabled + +## OPTIONS + +**--machine** *\* +ID of the machine to enable/query infinite boot + +**-r**, **--reboot** +Issue reboot to apply BIOS change + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine is-infinite-boot-enabled --machine 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-lockdown-status.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-lockdown-status.md new file mode 100644 index 0000000000..34c6ec17e3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-lockdown-status.md @@ -0,0 +1,51 @@ +# `nico-admin-cli bmc-machine lockdown-status` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **lockdown-status**_ + +## NAME + +nico-admin-cli-bmc-machine-lockdown-status - Check lockdown status + +## SYNOPSIS + +**nico-admin-cli bmc-machine lockdown-status** \<**--machine**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Check lockdown status + +## OPTIONS + +**--machine** *\* +ID of the machine to check lockdown status + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine lockdown-status --machine 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-lockdown.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-lockdown.md new file mode 100644 index 0000000000..6a0b765bad --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine-lockdown.md @@ -0,0 +1,63 @@ +# `nico-admin-cli bmc-machine lockdown` + +_[Hardware commands](../../hardware.md) › [bmc-machine](./bmc-machine.md) › **lockdown**_ + +## NAME + +nico-admin-cli-bmc-machine-lockdown - Enable or disable lockdown + +## SYNOPSIS + +**nico-admin-cli bmc-machine lockdown** \<**--machine**\> +\[**-r**\|**--reboot**\] \[**--enable**\] \[**--disable**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable or disable lockdown + +## OPTIONS + +**--machine** *\* +ID of the machine to enable/disable lockdown + +**-r**, **--reboot** +Issue reboot to apply lockdown change + +**--enable** +Enable lockdown + +**--disable** +Disable lockdown + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli bmc-machine lockdown --machine 12345678-1234-5678-90ab-cdef01234567 --enable +nico-admin-cli bmc-machine lockdown --machine 12345678-1234-5678-90ab-cdef01234567 --disable +nico-admin-cli bmc-machine lockdown --machine 12345678-1234-5678-90ab-cdef01234567 --enable --reboot +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine.md b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine.md new file mode 100644 index 0000000000..516eec3f87 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/bmc-machine/bmc-machine.md @@ -0,0 +1,55 @@ +# `nico-admin-cli bmc-machine` + +_[Hardware commands](../../hardware.md) › **bmc-machine**_ + +## NAME + +nico-admin-cli-bmc-machine - BMC Machine related handling + +## SYNOPSIS + +**nico-admin-cli bmc-machine** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +BMC Machine related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`bmc-reset`](./bmc-machine-bmc-reset.md) | Reset BMC | +| [`admin-power-control`](./bmc-machine-admin-power-control.md) | Redfish Power Control | +| [`create-bmc-user`](./bmc-machine-create-bmc-user.md) | | +| [`delete-bmc-user`](./bmc-machine-delete-bmc-user.md) | | +| [`enable-infinite-boot`](./bmc-machine-enable-infinite-boot.md) | Enable infinite boot | +| [`is-infinite-boot-enabled`](./bmc-machine-is-infinite-boot-enabled.md) | Check if infinite boot is enabled | +| [`lockdown`](./bmc-machine-lockdown.md) | Enable or disable lockdown | +| [`lockdown-status`](./bmc-machine-lockdown-status.md) | Check lockdown status | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-clear.md b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-clear.md new file mode 100644 index 0000000000..b40b57d822 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-clear.md @@ -0,0 +1,48 @@ +# `nico-admin-cli boot-override clear` + +_[Hardware commands](../../hardware.md) › [boot-override](./boot-override.md) › **clear**_ + +## NAME + +nico-admin-cli-boot-override-clear + +## SYNOPSIS + +**nico-admin-cli boot-override clear** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INTERFACE_ID*\> + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> + +## Examples + +```sh +nico-admin-cli boot-override clear 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-get.md b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-get.md new file mode 100644 index 0000000000..8c1cadf736 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-get.md @@ -0,0 +1,48 @@ +# `nico-admin-cli boot-override get` + +_[Hardware commands](../../hardware.md) › [boot-override](./boot-override.md) › **get**_ + +## NAME + +nico-admin-cli-boot-override-get + +## SYNOPSIS + +**nico-admin-cli boot-override get** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INTERFACE_ID*\> + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> + +## Examples + +```sh +nico-admin-cli boot-override get 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-set.md b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-set.md new file mode 100644 index 0000000000..8f0099cf7a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override-set.md @@ -0,0 +1,53 @@ +# `nico-admin-cli boot-override set` + +_[Hardware commands](../../hardware.md) › [boot-override](./boot-override.md) › **set**_ + +## NAME + +nico-admin-cli-boot-override-set + +## SYNOPSIS + +**nico-admin-cli boot-override set** \[**-p**\|**--custom-pxe**\] +\[**-u**\|**--custom-user-data**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*INTERFACE_ID*\> + +## DESCRIPTION + +## OPTIONS + +**-p**, **--custom-pxe** *\* +**-u**, **--custom-user-data** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> + +## Examples + +```sh +nico-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 --custom-pxe ./boot.ipxe +nico-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 --custom-user-data ./user-data.yaml +nico-admin-cli boot-override set 12345678-1234-5678-90ab-cdef01234567 --custom-pxe ./boot.ipxe --custom-user-data ./user-data.yaml +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/boot-override/boot-override.md b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override.md new file mode 100644 index 0000000000..676ef6390e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/boot-override/boot-override.md @@ -0,0 +1,50 @@ +# `nico-admin-cli boot-override` + +_[Hardware commands](../../hardware.md) › **boot-override**_ + +## NAME + +nico-admin-cli-boot-override - Machine boot override + +## SYNOPSIS + +**nico-admin-cli boot-override** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Machine boot override + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`get`](./boot-override-get.md) | | +| [`set`](./boot-override-set.md) | | +| [`clear`](./boot-override-clear.md) | | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/browse/browse-nmxc.md b/docs/manuals/nico-admin-cli/commands/browse/browse-nmxc.md new file mode 100644 index 0000000000..a824a7f9ba --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/browse/browse-nmxc.md @@ -0,0 +1,70 @@ +# `nico-admin-cli browse nmxc` + +_[Hardware commands](../../hardware.md) › [browse](./browse.md) › **nmxc**_ + +## NAME + +nico-admin-cli-browse-nmxc - Run an NMX-C browse operation via the API +server + +## SYNOPSIS + +**nico-admin-cli browse nmxc** \<**--chassis-serial**\> +\<**--operation**\> \[**--gpu-uid**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Run an NMX-C browse operation via the API server + +## OPTIONS + +**--chassis-serial** *\* +Chassis serial number + +**--operation** *\* +NMX-C browse operation to run\ + +\ +*Possible values:* + +- compute-node-info-list + +- gpu-info + +- gpu-info-list + +**--gpu-uid** *\* \[default: 0\] +GPU UID (used by the gpu-info operation) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli browse nmxc --chassis-serial 1234567890 --operation gpu-info-list +nico-admin-cli browse nmxc --chassis-serial 1234567890 --operation compute-node-info-list +nico-admin-cli browse nmxc --chassis-serial 1234567890 --operation gpu-info --gpu-uid 42 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/browse/browse-redfish.md b/docs/manuals/nico-admin-cli/commands/browse/browse-redfish.md new file mode 100644 index 0000000000..246309f2f9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/browse/browse-redfish.md @@ -0,0 +1,52 @@ +# `nico-admin-cli browse redfish` + +_[Hardware commands](../../hardware.md) › [browse](./browse.md) › **redfish**_ + +## NAME + +nico-admin-cli-browse-redfish - Browse a Redfish resource tree via the +API server + +## SYNOPSIS + +**nico-admin-cli browse redfish** \<**--uri**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Browse a Redfish resource tree via the API server + +## OPTIONS + +**--uri** *\* +Redfish URI + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli browse redfish --uri /redfish/v1/Systems +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/browse/browse-ufm.md b/docs/manuals/nico-admin-cli/commands/browse/browse-ufm.md new file mode 100644 index 0000000000..71368f0263 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/browse/browse-ufm.md @@ -0,0 +1,54 @@ +# `nico-admin-cli browse ufm` + +_[Hardware commands](../../hardware.md) › [browse](./browse.md) › **ufm**_ + +## NAME + +nico-admin-cli-browse-ufm - Browse a UFM fabric via the API server + +## SYNOPSIS + +**nico-admin-cli browse ufm** \<**--fabric-id**\> \<**--path**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Browse a UFM fabric via the API server + +## OPTIONS + +**--fabric-id** *\* +UFM fabric ID + +**--path** *\* +Path to browse within the fabric + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli browse ufm --fabric-id default --path /ufmRest/resources/systems +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/browse/browse.md b/docs/manuals/nico-admin-cli/commands/browse/browse.md new file mode 100644 index 0000000000..b7f005ccde --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/browse/browse.md @@ -0,0 +1,51 @@ +# `nico-admin-cli browse` + +_[Hardware commands](../../hardware.md) › **browse**_ + +## NAME + +nico-admin-cli-browse - Browse subsystem resource trees via the API +server + +## SYNOPSIS + +**nico-admin-cli browse** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Browse subsystem resource trees via the API server + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`redfish`](./browse-redfish.md) | Browse a Redfish resource tree via the API server | +| [`ufm`](./browse-ufm.md) | Browse a UFM fabric via the API server | +| [`nmxc`](./browse-nmxc.md) | Run an NMX-C browse operation via the API server | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-compute-tray.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-compute-tray.md new file mode 100644 index 0000000000..712792673f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-compute-tray.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager component-power-control compute-tray` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [component-power-control](./component-manager-component-power-control.md) › **compute-tray**_ + +## NAME + +nico-admin-cli-component-manager-component-power-control-compute-tray - +Target compute trays + +## SYNOPSIS + +**nico-admin-cli component-manager component-power-control +compute-tray** \<**--machine-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target compute trays + +## OPTIONS + +**--machine-id** *\...* +Machine IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-power-shelf.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-power-shelf.md new file mode 100644 index 0000000000..4b7eaf6454 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-power-shelf.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager component-power-control power-shelf` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [component-power-control](./component-manager-component-power-control.md) › **power-shelf**_ + +## NAME + +nico-admin-cli-component-manager-component-power-control-power-shelf - +Target power shelves + +## SYNOPSIS + +**nico-admin-cli component-manager component-power-control power-shelf** +\<**--power-shelf-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target power shelves + +## OPTIONS + +**--power-shelf-id** *\...* +Power shelf IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-switch.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-switch.md new file mode 100644 index 0000000000..1295d34203 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control-switch.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager component-power-control switch` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [component-power-control](./component-manager-component-power-control.md) › **switch**_ + +## NAME + +nico-admin-cli-component-manager-component-power-control-switch - Target +NVLink switches + +## SYNOPSIS + +**nico-admin-cli component-manager component-power-control switch** +\<**--switch-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target NVLink switches + +## OPTIONS + +**--switch-id** *\...* +Switch IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control.md new file mode 100644 index 0000000000..86be8535f9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-component-power-control.md @@ -0,0 +1,84 @@ +# `nico-admin-cli component-manager component-power-control` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › **component-power-control**_ + +## NAME + +nico-admin-cli-component-manager-component-power-control - Issue a +power-control action against components (switches, power shelves, +compute trays) + +## SYNOPSIS + +**nico-admin-cli component-manager component-power-control** +\<**--action**\> \[**--bypass-state-controller**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Issue a power-control action against components (switches, power +shelves, compute trays) + +## OPTIONS + +**--action** *\* +Power control action to apply to the targeted components\ + +\ +*Possible values:* + +- on + +- graceful-shutdown + +- force-off + +- graceful-restart + +- force-restart + +- ac-powercycle + +**--bypass-state-controller** +Bypass the state controller and dispatch directly to the component +backend + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli component-manager component-power-control switch --switch-id 12345678-1234-5678-90ab-cdef01234567 --action on +nico-admin-cli component-manager component-power-control compute-tray --machine-id 12345678-1234-5678-90ab-cdef01234567 --action force-off +nico-admin-cli component-manager component-power-control power-shelf --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 --action ac-powercycle +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`switch`](./component-manager-component-power-control-switch.md) | Target NVLink switches | +| [`power-shelf`](./component-manager-component-power-control-power-shelf.md) | Target power shelves | +| [`compute-tray`](./component-manager-component-power-control-compute-tray.md) | Target compute trays | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-compute-tray.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-compute-tray.md new file mode 100644 index 0000000000..8f99c9e117 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-compute-tray.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-update-status compute-tray` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-update-status](./component-manager-get-firmware-update-status.md) › **compute-tray**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-update-status-compute-tray - +Target compute trays + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-update-status +compute-tray** \<**--machine-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target compute trays + +## OPTIONS + +**--machine-id** *\...* +Machine IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-power-shelf.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-power-shelf.md new file mode 100644 index 0000000000..50f2d7b864 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-power-shelf.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-update-status power-shelf` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-update-status](./component-manager-get-firmware-update-status.md) › **power-shelf**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-update-status-power-shelf - +Target power shelves + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-update-status +power-shelf** \<**--power-shelf-id**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Target power shelves + +## OPTIONS + +**--power-shelf-id** *\...* +Power shelf IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-rack.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-rack.md new file mode 100644 index 0000000000..bec87850ab --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-rack.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-update-status rack` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-update-status](./component-manager-get-firmware-update-status.md) › **rack**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-update-status-rack - +Target racks + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-update-status rack** +\<**--rack-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target racks + +## OPTIONS + +**--rack-id** *\...* +Rack IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-switch.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-switch.md new file mode 100644 index 0000000000..eada14ce3d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status-switch.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-update-status switch` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-update-status](./component-manager-get-firmware-update-status.md) › **switch**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-update-status-switch - +Target NVLink switches + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-update-status switch** +\<**--switch-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target NVLink switches + +## OPTIONS + +**--switch-id** *\...* +Switch IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status.md new file mode 100644 index 0000000000..90d66424b2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-update-status.md @@ -0,0 +1,61 @@ +# `nico-admin-cli component-manager get-firmware-update-status` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › **get-firmware-update-status**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-update-status - Get +component firmware update status + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-update-status** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +Get component firmware update status + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli component-manager get-firmware-update-status switch --switch-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli component-manager get-firmware-update-status compute-tray --machine-id 12345678-1234-5678-90ab-cdef01234567,abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli component-manager get-firmware-update-status rack --rack-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`switch`](./component-manager-get-firmware-update-status-switch.md) | Target NVLink switches | +| [`power-shelf`](./component-manager-get-firmware-update-status-power-shelf.md) | Target power shelves | +| [`compute-tray`](./component-manager-get-firmware-update-status-compute-tray.md) | Target compute trays | +| [`rack`](./component-manager-get-firmware-update-status-rack.md) | Target racks | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-compute-tray.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-compute-tray.md new file mode 100644 index 0000000000..0ee70878ce --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-compute-tray.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-versions compute-tray` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-versions](./component-manager-get-firmware-versions.md) › **compute-tray**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-versions-compute-tray - +Target compute trays + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-versions compute-tray** +\<**--machine-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target compute trays + +## OPTIONS + +**--machine-id** *\...* +Machine IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-power-shelf.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-power-shelf.md new file mode 100644 index 0000000000..c2cdc6f734 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-power-shelf.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-versions power-shelf` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-versions](./component-manager-get-firmware-versions.md) › **power-shelf**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-versions-power-shelf - +Target power shelves + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-versions power-shelf** +\<**--power-shelf-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target power shelves + +## OPTIONS + +**--power-shelf-id** *\...* +Power shelf IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-rack.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-rack.md new file mode 100644 index 0000000000..c2c4843f07 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-rack.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-versions rack` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-versions](./component-manager-get-firmware-versions.md) › **rack**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-versions-rack - Target +racks + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-versions rack** +\<**--rack-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target racks + +## OPTIONS + +**--rack-id** *\...* +Rack IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-switch.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-switch.md new file mode 100644 index 0000000000..f6975510c6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions-switch.md @@ -0,0 +1,47 @@ +# `nico-admin-cli component-manager get-firmware-versions switch` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [get-firmware-versions](./component-manager-get-firmware-versions.md) › **switch**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-versions-switch - Target +NVLink switches + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-versions switch** +\<**--switch-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Target NVLink switches + +## OPTIONS + +**--switch-id** *\...* +Switch IDs to target + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions.md new file mode 100644 index 0000000000..8c80f5c994 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-get-firmware-versions.md @@ -0,0 +1,61 @@ +# `nico-admin-cli component-manager get-firmware-versions` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › **get-firmware-versions**_ + +## NAME + +nico-admin-cli-component-manager-get-firmware-versions - List available +component firmware versions + +## SYNOPSIS + +**nico-admin-cli component-manager get-firmware-versions** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*subcommands*\> + +## DESCRIPTION + +List available component firmware versions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli component-manager get-firmware-versions switch --switch-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli component-manager get-firmware-versions power-shelf --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli component-manager get-firmware-versions rack --rack-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`switch`](./component-manager-get-firmware-versions-switch.md) | Target NVLink switches | +| [`power-shelf`](./component-manager-get-firmware-versions-power-shelf.md) | Target power shelves | +| [`compute-tray`](./component-manager-get-firmware-versions-compute-tray.md) | Target compute trays | +| [`rack`](./component-manager-get-firmware-versions-rack.md) | Target racks | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-compute-tray.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-compute-tray.md new file mode 100644 index 0000000000..1c83837305 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-compute-tray.md @@ -0,0 +1,77 @@ +# `nico-admin-cli component-manager update-firmware compute-tray` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [update-firmware](./component-manager-update-firmware.md) › **compute-tray**_ + +## NAME + +nico-admin-cli-component-manager-update-firmware-compute-tray - Queue +firmware on compute trays + +## SYNOPSIS + +**nico-admin-cli component-manager update-firmware compute-tray** +\<**--machine-id**\> \[**--target-version**\] \[**--sot-json-file**\] +\[**--access-token**\] \[**--force-update**\] \[**--component**\] +\[**--bypass-state-controller**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Queue firmware on compute trays + +## OPTIONS + +**--machine-id** *\...* +Machine IDs to target + +**--target-version** *\* +Firmware target version for legacy direct-update paths + +**--sot-json-file** *\* +SOT JSON file for RMS ApplyFirmwareObjectFromJSON + +**--access-token** *\* +Artifact access token for RMS SOT JSON downloads; omit or pass empty for +NOAUTH + +**--force-update** +Force firmware update when supported + +**--component** *\* +Compute tray components to update; omit to update all supported +components\ + +\ +*Possible values:* + +- bmc + +- bios + +**--bypass-state-controller** +Bypass the state controller and dispatch directly to the component +backend + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-power-shelf.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-power-shelf.md new file mode 100644 index 0000000000..38fa1216f4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-power-shelf.md @@ -0,0 +1,69 @@ +# `nico-admin-cli component-manager update-firmware power-shelf` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [update-firmware](./component-manager-update-firmware.md) › **power-shelf**_ + +## NAME + +nico-admin-cli-component-manager-update-firmware-power-shelf - Queue +firmware on power shelves + +## SYNOPSIS + +**nico-admin-cli component-manager update-firmware power-shelf** +\<**--power-shelf-id**\> \<**--target-version**\> \[**--force-update**\] +\[**--component**\] \[**--bypass-state-controller**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Queue firmware on power shelves + +## OPTIONS + +**--power-shelf-id** *\...* +Power shelf IDs to target + +**--target-version** *\* +Firmware target version + +**--force-update** +Force firmware update when supported + +**--component** *\* +Power shelf components to update; omit to update all supported +components\ + +\ +*Possible values:* + +- pmc + +- psu + +**--bypass-state-controller** +Bypass the state controller and dispatch directly to the component +backend + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-rack.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-rack.md new file mode 100644 index 0000000000..1bac109dfc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-rack.md @@ -0,0 +1,61 @@ +# `nico-admin-cli component-manager update-firmware rack` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [update-firmware](./component-manager-update-firmware.md) › **rack**_ + +## NAME + +nico-admin-cli-component-manager-update-firmware-rack - Queue firmware +on all eligible devices in racks + +## SYNOPSIS + +**nico-admin-cli component-manager update-firmware rack** +\<**--rack-id**\> \[**--target-version**\] \[**--sot-json-file**\] +\[**--access-token**\] \[**--force-update**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Queue firmware on all eligible devices in racks + +## OPTIONS + +**--rack-id** *\...* +Rack IDs to target + +**--target-version** *\* +Firmware target version for legacy direct-update paths + +**--sot-json-file** *\* +SOT JSON file for RMS ApplyFirmwareObjectFromJSON + +**--access-token** *\* +Artifact access token for RMS SOT JSON downloads; omit or pass empty for +NOAUTH + +**--force-update** +Force firmware update when supported + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-switch.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-switch.md new file mode 100644 index 0000000000..4461a6171a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware-switch.md @@ -0,0 +1,81 @@ +# `nico-admin-cli component-manager update-firmware switch` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › [update-firmware](./component-manager-update-firmware.md) › **switch**_ + +## NAME + +nico-admin-cli-component-manager-update-firmware-switch - Queue firmware +on NVLink switches + +## SYNOPSIS + +**nico-admin-cli component-manager update-firmware switch** +\<**--switch-id**\> \[**--target-version**\] \[**--sot-json-file**\] +\[**--access-token**\] \[**--force-update**\] \[**--component**\] +\[**--bypass-state-controller**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Queue firmware on NVLink switches + +## OPTIONS + +**--switch-id** *\...* +Switch IDs to target + +**--target-version** *\* +Firmware target version for legacy direct-update paths + +**--sot-json-file** *\* +SOT JSON file for RMS ApplyFirmwareObjectFromJSON + +**--access-token** *\* +Artifact access token for RMS SOT JSON downloads; omit or pass empty for +NOAUTH + +**--force-update** +Force firmware update when supported + +**--component** *\* +NVLink switch components to update; omit to update all supported +components\ + +\ +*Possible values:* + +- bmc + +- cpld + +- bios + +- nvos + +**--bypass-state-controller** +Bypass the state controller and dispatch directly to the component +backend + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware.md new file mode 100644 index 0000000000..a837e4dc75 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager-update-firmware.md @@ -0,0 +1,62 @@ +# `nico-admin-cli component-manager update-firmware` + +_[Hardware commands](../../hardware.md) › [component-manager](./component-manager.md) › **update-firmware**_ + +## NAME + +nico-admin-cli-component-manager-update-firmware - Queue component +firmware updates + +## SYNOPSIS + +**nico-admin-cli component-manager update-firmware** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Queue component firmware updates + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli component-manager update-firmware switch --switch-id 12345678-1234-5678-90ab-cdef01234567 --target-version fw-1.2.3 +nico-admin-cli component-manager update-firmware switch --switch-id 12345678-1234-5678-90ab-cdef01234567 --component bmc,bios --force-update --target-version fw-1.2.3 +nico-admin-cli component-manager update-firmware compute-tray --machine-id 12345678-1234-5678-90ab-cdef01234567 --sot-json-file ./sot.json --access-token mytoken +nico-admin-cli component-manager update-firmware power-shelf --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 --target-version fw-1.2.3 +nico-admin-cli component-manager update-firmware rack --rack-id 12345678-1234-5678-90ab-cdef01234567 --target-version fw-1.2.3 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`switch`](./component-manager-update-firmware-switch.md) | Queue firmware on NVLink switches | +| [`power-shelf`](./component-manager-update-firmware-power-shelf.md) | Queue firmware on power shelves | +| [`compute-tray`](./component-manager-update-firmware-compute-tray.md) | Queue firmware on compute trays | +| [`rack`](./component-manager-update-firmware-rack.md) | Queue firmware on all eligible devices in racks | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/component-manager/component-manager.md b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager.md new file mode 100644 index 0000000000..9c226b708a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/component-manager/component-manager.md @@ -0,0 +1,51 @@ +# `nico-admin-cli component-manager` + +_[Hardware commands](../../hardware.md) › **component-manager**_ + +## NAME + +nico-admin-cli-component-manager - Component manager actions + +## SYNOPSIS + +**nico-admin-cli component-manager** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Component manager actions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`update-firmware`](./component-manager-update-firmware.md) | Queue component firmware updates | +| [`get-firmware-update-status`](./component-manager-get-firmware-update-status.md) | Get component firmware update status | +| [`get-firmware-versions`](./component-manager-get-firmware-versions.md) | List available component firmware versions | +| [`component-power-control`](./component-manager-component-power-control.md) | Issue a power-control action against components (switches, power shelves, compute trays) | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-create.md b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-create.md new file mode 100644 index 0000000000..c8b340b529 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-create.md @@ -0,0 +1,74 @@ +# `nico-admin-cli compute-allocation create` + +_[Tenant commands](../../tenant.md) › [compute-allocation](./compute-allocation.md) › **create**_ + +## NAME + +nico-admin-cli-compute-allocation-create - Create a compute allocation + +## SYNOPSIS + +**nico-admin-cli compute-allocation create** \[**-i**\|**--id**\] +\<**-t**\|**--tenant-organization-id**\> \<**--instance-type-id**\> +\<**-c**\|**--count**\> \[**-n**\|**--name**\] +\[**-d**\|**--description**\] \[**-l**\|**--labels**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create a compute allocation + +## OPTIONS + +**-i**, **--id** *\* +Optional, unique ID to use when creating the compute allocation + +**-t**, **--tenant-organization-id** *\* +Tenant organization ID for the compute allocation + +**--instance-type-id** *\* +Instance type ID from which compute is being allocated + +**-c**, **--count** *\* +Count to allocate for the instance type + +**-n**, **--name** *\* +Name of the compute allocation + +**-d**, **--description** *\* +Description of the compute allocation + +**-l**, **--labels** *\* +JSON map of simple key:value pairs to be applied as labels to the +compute allocation + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli compute-allocation create --tenant-organization-id fds34511233a --instance-type-id DGX-H100-640GB --count 8 +nico-admin-cli compute-allocation create --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a --instance-type-id DGX-H100-640GB --count 8 --name "training-pool" --labels '{"team":"research"}' +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-delete.md b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-delete.md new file mode 100644 index 0000000000..2bb5b1be98 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-delete.md @@ -0,0 +1,55 @@ +# `nico-admin-cli compute-allocation delete` + +_[Tenant commands](../../tenant.md) › [compute-allocation](./compute-allocation.md) › **delete**_ + +## NAME + +nico-admin-cli-compute-allocation-delete - Delete a compute allocation + +## SYNOPSIS + +**nico-admin-cli compute-allocation delete** \<**-i**\|**--id**\> +\<**-t**\|**--tenant-organization-id**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete a compute allocation + +## OPTIONS + +**-i**, **--id** *\* +Compute allocation ID to delete + +**-t**, **--tenant-organization-id** *\* +Tenant organization ID for the compute allocation + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli compute-allocation delete --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-show.md b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-show.md new file mode 100644 index 0000000000..b8f4099d28 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-show.md @@ -0,0 +1,66 @@ +# `nico-admin-cli compute-allocation show` + +_[Tenant commands](../../tenant.md) › [compute-allocation](./compute-allocation.md) › **show**_ + +## NAME + +nico-admin-cli-compute-allocation-show - Show one or more compute +allocations + +## SYNOPSIS + +**nico-admin-cli compute-allocation show** \[**-i**\|**--id**\] +\[**-t**\|**--tenant-organization-id**\] \[**-n**\|**--name**\] +\[**--instance-type-id**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Show one or more compute allocations + +## OPTIONS + +**-i**, **--id** *\* +Optional, compute allocation ID to restrict the search + +**-t**, **--tenant-organization-id** *\* +Optional, tenant organization ID used to filter results + +**-n**, **--name** *\* +Optional, name used to filter results + +**--instance-type-id** *\* +Optional, instance type ID used to filter results + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli compute-allocation show +nico-admin-cli compute-allocation show --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli compute-allocation show --tenant-organization-id fds34511233a +nico-admin-cli compute-allocation show --instance-type-id DGX-H100-640GB +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-update.md b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-update.md new file mode 100644 index 0000000000..eae89ed34f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation-update.md @@ -0,0 +1,81 @@ +# `nico-admin-cli compute-allocation update` + +_[Tenant commands](../../tenant.md) › [compute-allocation](./compute-allocation.md) › **update**_ + +## NAME + +nico-admin-cli-compute-allocation-update - Update a compute allocation + +## SYNOPSIS + +**nico-admin-cli compute-allocation update** \<**-i**\|**--id**\> +\<**-t**\|**--tenant-organization-id**\> \[**-n**\|**--name**\] +\[**-d**\|**--description**\] \[**-l**\|**--labels**\] +\[**--instance-type-id**\] \[**-c**\|**--count**\] +\[**-v**\|**--version**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update a compute allocation + +## OPTIONS + +**-i**, **--id** *\* +Compute allocation ID to update + +**-t**, **--tenant-organization-id** *\* +Tenant organization ID for the compute allocation + +**-n**, **--name** *\* +Name of the compute allocation + +**-d**, **--description** *\* +Description of the compute allocation + +**-l**, **--labels** *\* +JSON map of simple key:value pairs to be applied as labels to the +compute allocation - will COMPLETELY overwrite any existing labels + +**--instance-type-id** *\* +Optional, updated instance type ID for the allocation + +**-c**, **--count** *\* +Optional, updated count for the allocation + +**-v**, **--version** *\* +Optional, version to use for comparison when performing the update, +which will be rejected if the actual version of the record does not +match the value of this parameter + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a --count 16 +nico-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a --name "prod-pool" --description "Production capacity" +nico-admin-cli compute-allocation update --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a --labels '{"team":"research"}' --version 3 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation.md b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation.md new file mode 100644 index 0000000000..3c5298ed75 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/compute-allocation/compute-allocation.md @@ -0,0 +1,51 @@ +# `nico-admin-cli compute-allocation` + +_[Tenant commands](../../tenant.md) › **compute-allocation**_ + +## NAME + +nico-admin-cli-compute-allocation - Compute allocation management + +## SYNOPSIS + +**nico-admin-cli compute-allocation** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Compute allocation management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./compute-allocation-create.md) | Create a compute allocation | +| [`show`](./compute-allocation-show.md) | Show one or more compute allocations | +| [`delete`](./compute-allocation-delete.md) | Delete a compute allocation | +| [`update`](./compute-allocation-update.md) | Update a compute allocation | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-add-bmc.md b/docs/manuals/nico-admin-cli/commands/credential/credential-add-bmc.md new file mode 100644 index 0000000000..6435819e19 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-add-bmc.md @@ -0,0 +1,71 @@ +# `nico-admin-cli credential add-bmc` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **add-bmc**_ + +## NAME + +nico-admin-cli-credential-add-bmc - Add BMC credentials + +## SYNOPSIS + +**nico-admin-cli credential add-bmc** \<**--kind**\> \<**--password**\> +\[**--username**\] \[**--mac-address**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add BMC credentials + +## OPTIONS + +**--kind**=*\* +The BMC Credential kind\ + +\ +*Possible values:* + +- site-wide-root + +- bmc-root + +- bmc-forge-admin + +**--password** *\* +The password of BMC + +**--username** *\* +The username of BMC + +**--mac-address** *\* +The MAC address of the BMC + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential add-bmc --kind=site-wide-root --username admin --password mypassword +nico-admin-cli credential add-bmc --kind=bmc-root --username admin --password mypassword --mac-address 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-add-dpu-factory-default.md b/docs/manuals/nico-admin-cli/commands/credential/credential-add-dpu-factory-default.md new file mode 100644 index 0000000000..e72db57de6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-add-dpu-factory-default.md @@ -0,0 +1,56 @@ +# `nico-admin-cli credential add-dpu-factory-default` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **add-dpu-factory-default**_ + +## NAME + +nico-admin-cli-credential-add-dpu-factory-default - Add manufacturer +factory default BMC user/pass for the DPUs + +## SYNOPSIS + +**nico-admin-cli credential add-dpu-factory-default** \<**--username**\> +\<**--password**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Add manufacturer factory default BMC user/pass for the DPUs + +## OPTIONS + +**--username** *\* +Default username: root, ADMIN, etc + +**--password** *\* +DPU manufacturer default password + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential add-dpu-factory-default --username admin --password mypassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-add-host-factory-default.md b/docs/manuals/nico-admin-cli/commands/credential/credential-add-host-factory-default.md new file mode 100644 index 0000000000..8421127efb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-add-host-factory-default.md @@ -0,0 +1,78 @@ +# `nico-admin-cli credential add-host-factory-default` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **add-host-factory-default**_ + +## NAME + +nico-admin-cli-credential-add-host-factory-default - Add manufacturer +factory default BMC user/pass for a given vendor + +## SYNOPSIS + +**nico-admin-cli credential add-host-factory-default** +\<**--username**\> \<**--password**\> \<**--vendor**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add manufacturer factory default BMC user/pass for a given vendor + +## OPTIONS + +**--username** *\* +Default username: root, ADMIN, etc + +**--password** *\* +Manufacturer default password + +**--vendor** *\* +\ +*Possible values:* + +- lenovo + +- lenovo-ami + +- dell + +- supermicro + +- hpe + +- nvidia + +- liteon + +- delta + +- unknown + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential add-host-factory-default --vendor nvidia --username admin --password mypassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-add-nmx-m.md b/docs/manuals/nico-admin-cli/commands/credential/credential-add-nmx-m.md new file mode 100644 index 0000000000..d448310f4c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-add-nmx-m.md @@ -0,0 +1,55 @@ +# `nico-admin-cli credential add-nmx-m` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **add-nmx-m**_ + +## NAME + +nico-admin-cli-credential-add-nmx-m - Add NmxM credentials + +## SYNOPSIS + +**nico-admin-cli credential add-nmx-m** \<**--username**\> +\<**--password**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Add NmxM credentials + +## OPTIONS + +**--username** *\* +Username + +**--password** *\* +password + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential add-nmx-m --username admin --password mypassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-add-uefi.md b/docs/manuals/nico-admin-cli/commands/credential/credential-add-uefi.md new file mode 100644 index 0000000000..1131b31d32 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-add-uefi.md @@ -0,0 +1,64 @@ +# `nico-admin-cli credential add-uefi` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **add-uefi**_ + +## NAME + +nico-admin-cli-credential-add-uefi - Add site-wide DPU UEFI default +credential (NOTE: this parameter can be set only once) + +## SYNOPSIS + +**nico-admin-cli credential add-uefi** \<**--kind**\> \<**--password**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add site-wide DPU UEFI default credential (NOTE: this parameter can be +set only once) + +## OPTIONS + +**--kind**=*\* +The UEFI kind\ + +\ +*Possible values:* + +- dpu + +- host + +**--password**=*\* +The UEFI password + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential add-uefi --kind=dpu --password=mynewpassword +nico-admin-cli credential add-uefi --kind=host --password=mynewpassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-add-ufm.md b/docs/manuals/nico-admin-cli/commands/credential/credential-add-ufm.md new file mode 100644 index 0000000000..3385b49a03 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-add-ufm.md @@ -0,0 +1,54 @@ +# `nico-admin-cli credential add-ufm` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **add-ufm**_ + +## NAME + +nico-admin-cli-credential-add-ufm - Add UFM credential + +## SYNOPSIS + +**nico-admin-cli credential add-ufm** \<**--url**\> \[**--token**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add UFM credential + +## OPTIONS + +**--url** *\* +The UFM url + +**--token** *\* \[default: \] +The UFM token + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential add-ufm --url https://192.0.2.10 --token mypassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-bgp-delete-sitewide.md b/docs/manuals/nico-admin-cli/commands/credential/credential-bgp-delete-sitewide.md new file mode 100644 index 0000000000..c0015b4267 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-bgp-delete-sitewide.md @@ -0,0 +1,43 @@ +# `nico-admin-cli credential bgp delete-sitewide` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › [bgp](./credential-bgp.md) › **delete-sitewide**_ + +## NAME + +nico-admin-cli-credential-bgp-delete-sitewide - Delete the site-wide +leaf BGP password + +## SYNOPSIS + +**nico-admin-cli credential bgp delete-sitewide** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete the site-wide leaf BGP password + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-bgp-set-sitewide.md b/docs/manuals/nico-admin-cli/commands/credential/credential-bgp-set-sitewide.md new file mode 100644 index 0000000000..8fbdbef96f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-bgp-set-sitewide.md @@ -0,0 +1,52 @@ +# `nico-admin-cli credential bgp set-sitewide` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › [bgp](./credential-bgp.md) › **set-sitewide**_ + +## NAME + +nico-admin-cli-credential-bgp-set-sitewide - Set the site-wide leaf BGP +password + +## SYNOPSIS + +**nico-admin-cli credential bgp set-sitewide** \<**--password**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set the site-wide leaf BGP password + +## OPTIONS + +**--password** *\* +Leaf BGP session password + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential bgp set-sitewide --password mynewpassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-bgp.md b/docs/manuals/nico-admin-cli/commands/credential/credential-bgp.md new file mode 100644 index 0000000000..1d9832533b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-bgp.md @@ -0,0 +1,49 @@ +# `nico-admin-cli credential bgp` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **bgp**_ + +## NAME + +nico-admin-cli-credential-bgp - Manage leaf BGP passwords + +## SYNOPSIS + +**nico-admin-cli credential bgp** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage leaf BGP passwords + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set-sitewide`](./credential-bgp-set-sitewide.md) | Set the site-wide leaf BGP password | +| [`delete-sitewide`](./credential-bgp-delete-sitewide.md) | Delete the site-wide leaf BGP password | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-delete-bmc.md b/docs/manuals/nico-admin-cli/commands/credential/credential-delete-bmc.md new file mode 100644 index 0000000000..e3fa1a65d6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-delete-bmc.md @@ -0,0 +1,65 @@ +# `nico-admin-cli credential delete-bmc` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **delete-bmc**_ + +## NAME + +nico-admin-cli-credential-delete-bmc - Delete BMC credentials + +## SYNOPSIS + +**nico-admin-cli credential delete-bmc** \<**--kind**\> +\[**--mac-address**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Delete BMC credentials + +## OPTIONS + +**--kind**=*\* +The BMC Credential kind\ + +\ +*Possible values:* + +- site-wide-root + +- bmc-root + +- bmc-forge-admin + +**--mac-address** *\* +The MAC address of the BMC + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential delete-bmc --kind=site-wide-root +nico-admin-cli credential delete-bmc --kind=bmc-root --mac-address 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-delete-nmx-m.md b/docs/manuals/nico-admin-cli/commands/credential/credential-delete-nmx-m.md new file mode 100644 index 0000000000..4d66529ec3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-delete-nmx-m.md @@ -0,0 +1,51 @@ +# `nico-admin-cli credential delete-nmx-m` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **delete-nmx-m**_ + +## NAME + +nico-admin-cli-credential-delete-nmx-m - Delete NmxM credentials + +## SYNOPSIS + +**nico-admin-cli credential delete-nmx-m** \<**--username**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete NmxM credentials + +## OPTIONS + +**--username** *\* +NmxM url + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential delete-nmx-m --username admin +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-delete-ufm.md b/docs/manuals/nico-admin-cli/commands/credential/credential-delete-ufm.md new file mode 100644 index 0000000000..4594848bde --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-delete-ufm.md @@ -0,0 +1,51 @@ +# `nico-admin-cli credential delete-ufm` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **delete-ufm**_ + +## NAME + +nico-admin-cli-credential-delete-ufm - Delete UFM credential + +## SYNOPSIS + +**nico-admin-cli credential delete-ufm** \<**--url**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete UFM credential + +## OPTIONS + +**--url** *\* +The UFM url + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential delete-ufm --url https://192.0.2.10 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential-generate-ufm-cert.md b/docs/manuals/nico-admin-cli/commands/credential/credential-generate-ufm-cert.md new file mode 100644 index 0000000000..b55a8dd054 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential-generate-ufm-cert.md @@ -0,0 +1,52 @@ +# `nico-admin-cli credential generate-ufm-cert` + +_[Hardware commands](../../hardware.md) › [credential](./credential.md) › **generate-ufm-cert**_ + +## NAME + +nico-admin-cli-credential-generate-ufm-cert - Generate UFM credential + +## SYNOPSIS + +**nico-admin-cli credential generate-ufm-cert** \[**--fabric**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Generate UFM credential + +## OPTIONS + +**--fabric** *\* \[default: default\] +Infiniband fabric. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli credential generate-ufm-cert +nico-admin-cli credential generate-ufm-cert --fabric default +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/credential/credential.md b/docs/manuals/nico-admin-cli/commands/credential/credential.md new file mode 100644 index 0000000000..36eb2ac44b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/credential/credential.md @@ -0,0 +1,58 @@ +# `nico-admin-cli credential` + +_[Hardware commands](../../hardware.md) › **credential**_ + +## NAME + +nico-admin-cli-credential - Credential related handling + +## SYNOPSIS + +**nico-admin-cli credential** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Credential related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`add-ufm`](./credential-add-ufm.md) | Add UFM credential | +| [`delete-ufm`](./credential-delete-ufm.md) | Delete UFM credential | +| [`generate-ufm-cert`](./credential-generate-ufm-cert.md) | Generate UFM credential | +| [`add-bmc`](./credential-add-bmc.md) | Add BMC credentials | +| [`delete-bmc`](./credential-delete-bmc.md) | Delete BMC credentials | +| [`add-uefi`](./credential-add-uefi.md) | Add site-wide DPU UEFI default credential (NOTE: this parameter can be set only once) | +| [`add-host-factory-default`](./credential-add-host-factory-default.md) | Add manufacturer factory default BMC user/pass for a given vendor | +| [`add-dpu-factory-default`](./credential-add-dpu-factory-default.md) | Add manufacturer factory default BMC user/pass for the DPUs | +| [`add-nmx-m`](./credential-add-nmx-m.md) | Add NmxM credentials | +| [`delete-nmx-m`](./credential-delete-nmx-m.md) | Delete NmxM credentials | +| [`bgp`](./credential-bgp.md) | Manage leaf BGP passwords | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dev-env/dev-env-config-apply.md b/docs/manuals/nico-admin-cli/commands/dev-env/dev-env-config-apply.md new file mode 100644 index 0000000000..ddb9862fe7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dev-env/dev-env-config-apply.md @@ -0,0 +1,63 @@ +# `nico-admin-cli dev-env config apply` + +_[Admin commands](../../admin.md) › [dev-env](./dev-env.md) › [config](./dev-env-config.md) › **apply**_ + +## NAME + +nico-admin-cli-dev-env-config-apply - Apply devenv config + +## SYNOPSIS + +**nico-admin-cli dev-env config apply** \<**-m**\|**--mode**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*PATH*\> + +## DESCRIPTION + +Apply devenv config + +## OPTIONS + +**-m**, **--mode** *\* +Vpc prefix or network segment?\ + +\ +*Possible values:* + +- network-segment + +- vpc-prefix + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*PATH*\> +Path to devenv config file. Usually this is in forged repo at +envs/local-dev/site/site-controller/files/generated/devenv_config.toml + +## Examples + +```sh +nico-admin-cli dev-env config apply ./devenv_config.toml --mode network-segment +nico-admin-cli dev-env config apply ./devenv_config.toml --mode vpc-prefix +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dev-env/dev-env-config.md b/docs/manuals/nico-admin-cli/commands/dev-env/dev-env-config.md new file mode 100644 index 0000000000..dd9ae2e3e9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dev-env/dev-env-config.md @@ -0,0 +1,48 @@ +# `nico-admin-cli dev-env config` + +_[Admin commands](../../admin.md) › [dev-env](./dev-env.md) › **config**_ + +## NAME + +nico-admin-cli-dev-env-config - Config related handling + +## SYNOPSIS + +**nico-admin-cli dev-env config** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Config related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`apply`](./dev-env-config-apply.md) | Apply devenv config | + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dev-env/dev-env.md b/docs/manuals/nico-admin-cli/commands/dev-env/dev-env.md new file mode 100644 index 0000000000..8631d29c3e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dev-env/dev-env.md @@ -0,0 +1,48 @@ +# `nico-admin-cli dev-env` + +_[Admin commands](../../admin.md) › **dev-env**_ + +## NAME + +nico-admin-cli-dev-env - Dev Env related handling + +## SYNOPSIS + +**nico-admin-cli dev-env** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Dev Env related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`config`](./dev-env-config.md) | Config related handling | + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/domain/domain-show.md b/docs/manuals/nico-admin-cli/commands/domain/domain-show.md new file mode 100644 index 0000000000..dd99625f5b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/domain/domain-show.md @@ -0,0 +1,55 @@ +# `nico-admin-cli domain show` + +_[Network commands](../../network.md) › [domain](./domain.md) › **show**_ + +## NAME + +nico-admin-cli-domain-show - Display Domain information + +## SYNOPSIS + +**nico-admin-cli domain show** \[**-a**\|**--all**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*DOMAIN*\] + +## DESCRIPTION + +Display Domain information + +## OPTIONS + +**-a**, **--all** +Show all domains (DEPRECATED) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*DOMAIN*\] +The domain to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli domain show +nico-admin-cli domain show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/domain/domain.md b/docs/manuals/nico-admin-cli/commands/domain/domain.md new file mode 100644 index 0000000000..1bb9841c7d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/domain/domain.md @@ -0,0 +1,48 @@ +# `nico-admin-cli domain` + +_[Network commands](../../network.md) › **domain**_ + +## NAME + +nico-admin-cli-domain - Domain related handling + +## SYNOPSIS + +**nico-admin-cli domain** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Domain related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./domain-show.md) | Display Domain information | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpa/dpa-ensure.md b/docs/manuals/nico-admin-cli/commands/dpa/dpa-ensure.md new file mode 100644 index 0000000000..6edc1b2405 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpa/dpa-ensure.md @@ -0,0 +1,66 @@ +# `nico-admin-cli dpa ensure` + +_[Hardware commands](../../hardware.md) › [dpa](./dpa.md) › **ensure**_ + +## NAME + +nico-admin-cli-dpa-ensure - Create/ensure a DPA interface + +## SYNOPSIS + +**nico-admin-cli dpa ensure** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> \<*MAC_ADDR*\> \<*DEVICE_TYPE*\> +\<*PCI_NAME*\> \[*DEVICE_DESCRIPTION*\] + +## DESCRIPTION + +Create/ensure a DPA interface + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine ID + +\<*MAC_ADDR*\> +MAC address (e.g. 00:11:22:33:44:55) + +\<*DEVICE_TYPE*\> +Device type (e.g. BlueField3) + +\<*PCI_NAME*\> +PCI name (e.g. 5e:00.0) + +\[*DEVICE_DESCRIPTION*\] +Device description (e.g. NVIDIA BlueField-3 B3140L E-Series FHHL +SuperNIC) + +## Examples + +```sh +nico-admin-cli dpa ensure 12345678-1234-5678-90ab-cdef01234567 00:11:22:33:44:55 BlueField3 5e:00.0 +nico-admin-cli dpa ensure 12345678-1234-5678-90ab-cdef01234567 00:11:22:33:44:55 BlueField3 5e:00.0 "NVIDIA BlueField-3 B3140L E-Series FHHL SuperNIC" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpa/dpa-show.md b/docs/manuals/nico-admin-cli/commands/dpa/dpa-show.md new file mode 100644 index 0000000000..75d90e803c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpa/dpa-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli dpa show` + +_[Hardware commands](../../hardware.md) › [dpa](./dpa.md) › **show**_ + +## NAME + +nico-admin-cli-dpa-show - Display Dpa information + +## SYNOPSIS + +**nico-admin-cli dpa show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display Dpa information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +The DPA Interface ID to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli dpa show +nico-admin-cli dpa show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpa/dpa.md b/docs/manuals/nico-admin-cli/commands/dpa/dpa.md new file mode 100644 index 0000000000..c2bdaa4055 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpa/dpa.md @@ -0,0 +1,49 @@ +# `nico-admin-cli dpa` + +_[Hardware commands](../../hardware.md) › **dpa**_ + +## NAME + +nico-admin-cli-dpa - DPA related handling + +## SYNOPSIS + +**nico-admin-cli dpa** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +DPA related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`ensure`](./dpa-ensure.md) | Create/ensure a DPA interface | +| [`show`](./dpa-show.md) | Display Dpa information | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpf/dpf-disable.md b/docs/manuals/nico-admin-cli/commands/dpf/dpf-disable.md new file mode 100644 index 0000000000..97f7fcdee1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpf/dpf-disable.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpf disable` + +_[Hardware commands](../../hardware.md) › [dpf](./dpf.md) › **disable**_ + +## NAME + +nico-admin-cli-dpf-disable - Disable DPF + +## SYNOPSIS + +**nico-admin-cli dpf disable** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*HOST*\] + +## DESCRIPTION + +Disable DPF + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*HOST*\] +Host machine id + +## Examples + +```sh +nico-admin-cli dpf disable 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpf/dpf-enable.md b/docs/manuals/nico-admin-cli/commands/dpf/dpf-enable.md new file mode 100644 index 0000000000..3fa324ee86 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpf/dpf-enable.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpf enable` + +_[Hardware commands](../../hardware.md) › [dpf](./dpf.md) › **enable**_ + +## NAME + +nico-admin-cli-dpf-enable - Enable DPF + +## SYNOPSIS + +**nico-admin-cli dpf enable** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*HOST*\] + +## DESCRIPTION + +Enable DPF + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*HOST*\] +Host machine id + +## Examples + +```sh +nico-admin-cli dpf enable 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpf/dpf-service-version.md b/docs/manuals/nico-admin-cli/commands/dpf/dpf-service-version.md new file mode 100644 index 0000000000..1259046e4b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpf/dpf-service-version.md @@ -0,0 +1,50 @@ +# `nico-admin-cli dpf service-version` + +_[Hardware commands](../../hardware.md) › [dpf](./dpf.md) › **service-version**_ + +## NAME + +nico-admin-cli-dpf-service-version - Compare configured vs deployed DPF +service versions + +## SYNOPSIS + +**nico-admin-cli dpf service-version** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Compare configured vs deployed DPF service versions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpf service-version +nico-admin-cli dpf sv +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpf/dpf-show.md b/docs/manuals/nico-admin-cli/commands/dpf/dpf-show.md new file mode 100644 index 0000000000..12bc54d2f3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpf/dpf-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli dpf show` + +_[Hardware commands](../../hardware.md) › [dpf](./dpf.md) › **show**_ + +## NAME + +nico-admin-cli-dpf-show - Check Status of DPF + +## SYNOPSIS + +**nico-admin-cli dpf show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*HOST*\] + +## DESCRIPTION + +Check Status of DPF + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*HOST*\] +Host machine id + +## Examples + +```sh +nico-admin-cli dpf show +nico-admin-cli dpf show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpf/dpf-snapshot.md b/docs/manuals/nico-admin-cli/commands/dpf/dpf-snapshot.md new file mode 100644 index 0000000000..e70bdc807c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpf/dpf-snapshot.md @@ -0,0 +1,52 @@ +# `nico-admin-cli dpf snapshot` + +_[Hardware commands](../../hardware.md) › [dpf](./dpf.md) › **snapshot**_ + +## NAME + +nico-admin-cli-dpf-snapshot - Snapshot DPF CRs (DPUNode, DPUDevices, +DPUs) for a host + +## SYNOPSIS + +**nico-admin-cli dpf snapshot** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*HOST_MACHINE_ID*\> + +## DESCRIPTION + +Snapshot DPF CRs (DPUNode, DPUDevices, DPUs) for a host + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*HOST_MACHINE_ID*\> +Host machine id to snapshot. Must be a host (not a DPU) machine id + +## Examples + +```sh +nico-admin-cli dpf snapshot 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpf/dpf.md b/docs/manuals/nico-admin-cli/commands/dpf/dpf.md new file mode 100644 index 0000000000..d7b3265b13 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpf/dpf.md @@ -0,0 +1,60 @@ +# `nico-admin-cli dpf` + +_[Hardware commands](../../hardware.md) › **dpf**_ + +## NAME + +nico-admin-cli-dpf - DPF-related commands. Note: These commands update +the DPF state of the machine, which determines DPF-based DPU +re-provisioning. The state is saved in the machines metadata and will be +deleted if the machine is force-deleted. To make the state persistent, +add the DPF state for a machine (host) to the expected machines table. + +## SYNOPSIS + +**nico-admin-cli dpf** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +DPF-related commands. Note: These commands update the DPF state of the +machine, which determines DPF-based DPU re-provisioning. The state is +saved in the machines metadata and will be deleted if the machine is +force-deleted. To make the state persistent, add the DPF state for a +machine (host) to the expected machines table. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`enable`](./dpf-enable.md) | Enable DPF | +| [`disable`](./dpf-disable.md) | Disable DPF | +| [`show`](./dpf-show.md) | Check Status of DPF | +| [`snapshot`](./dpf-snapshot.md) | Snapshot DPF CRs (DPUNode, DPUDevices, DPUs) for a host | +| [`service-version`](./dpf-service-version.md) | Compare configured vs deployed DPF service versions | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-approve.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-approve.md new file mode 100644 index 0000000000..bfafcee16f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-approve.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpu-remediation approve` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **approve**_ + +## NAME + +nico-admin-cli-dpu-remediation-approve - Approve a remediation + +## SYNOPSIS + +**nico-admin-cli dpu-remediation approve** \<**--id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Approve a remediation + +## OPTIONS + +**--id** *\* +The id of the remediation to approve + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu-remediation approve --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-create.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-create.md new file mode 100644 index 0000000000..889f1a24da --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-create.md @@ -0,0 +1,72 @@ +# `nico-admin-cli dpu-remediation create` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **create**_ + +## NAME + +nico-admin-cli-dpu-remediation-create - Create a remediation + +## SYNOPSIS + +**nico-admin-cli dpu-remediation create** \<**--script-filename**\> +\[**--retries**\] \[**--meta-name**\] \[**--meta-description**\] +\[**--label**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Create a remediation + +## OPTIONS + +**--script-filename** *\* +The filename of the script to run + +**--retries** *\* +specify the amount of retries for the remediation, defaults to no +retries + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Remediations. Completely optional. + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Remediations. Completely optional. + +**--label** *\* +A label that will be added as metadata for the newly created +Remediation. The labels key and value must be separated by a : +character. E.g. DATACENTER:XYZ. Completely optional. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu-remediation create --script-filename ./remediate.sh +nico-admin-cli dpu-remediation create --script-filename ./remediate.sh --retries 3 +nico-admin-cli dpu-remediation create --script-filename ./remediate.sh --meta-name "clear-eeprom" --meta-description "Clears stale EEPROM state" --label DATACENTER:XYZ +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-disable.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-disable.md new file mode 100644 index 0000000000..2b204b4d66 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-disable.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpu-remediation disable` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **disable**_ + +## NAME + +nico-admin-cli-dpu-remediation-disable - Disable a remediation + +## SYNOPSIS + +**nico-admin-cli dpu-remediation disable** \<**--id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Disable a remediation + +## OPTIONS + +**--id** *\* +The id of the remediation to disable + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu-remediation disable --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-enable.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-enable.md new file mode 100644 index 0000000000..d7ce7e9d0b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-enable.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpu-remediation enable` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **enable**_ + +## NAME + +nico-admin-cli-dpu-remediation-enable - Enable a remediation + +## SYNOPSIS + +**nico-admin-cli dpu-remediation enable** \<**--id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable a remediation + +## OPTIONS + +**--id** *\* +The id of the remediation to enable + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu-remediation enable --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-list-applied.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-list-applied.md new file mode 100644 index 0000000000..859eb0a9ab --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-list-applied.md @@ -0,0 +1,63 @@ +# `nico-admin-cli dpu-remediation list-applied` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **list-applied**_ + +## NAME + +nico-admin-cli-dpu-remediation-list-applied - Display information about +applied remediations + +## SYNOPSIS + +**nico-admin-cli dpu-remediation list-applied** \[**--remediation-id**\] +\[**--machine-id**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Display information about applied remediations + +## OPTIONS + +**--remediation-id** *\* +The remediation id to query, in case the user wants to see which +machines have a specific remediation applied. Provide both arguments to +see all the details for a specific remediation and machine. + +**--machine-id** *\* +The machine id to query, in case the user wants to see which +remediations have been applied to a specific box. Provide both arguments +to see all the details for a specific remediation and machine. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu-remediation list-applied +nico-admin-cli dpu-remediation list-applied --remediation-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu-remediation list-applied --machine-id abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli dpu-remediation list-applied --remediation-id 12345678-1234-5678-90ab-cdef01234567 --machine-id abcdef01-2345-6789-abcd-ef0123456789 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-revoke.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-revoke.md new file mode 100644 index 0000000000..860e073fe0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-revoke.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpu-remediation revoke` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **revoke**_ + +## NAME + +nico-admin-cli-dpu-remediation-revoke - Revoke a remediation + +## SYNOPSIS + +**nico-admin-cli dpu-remediation revoke** \<**--id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Revoke a remediation + +## OPTIONS + +**--id** *\* +The id of the remediation to revoke + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu-remediation revoke --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-show.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-show.md new file mode 100644 index 0000000000..d1d4479d0b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation-show.md @@ -0,0 +1,54 @@ +# `nico-admin-cli dpu-remediation show` + +_[Hardware commands](../../hardware.md) › [dpu-remediation](./dpu-remediation.md) › **show**_ + +## NAME + +nico-admin-cli-dpu-remediation-show - Display remediation information + +## SYNOPSIS + +**nico-admin-cli dpu-remediation show** \[**--display-script**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display remediation information + +## OPTIONS + +**--display-script** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +The remediation id to query, if not provided defaults to all + +## Examples + +```sh +nico-admin-cli dpu-remediation show +nico-admin-cli dpu-remediation show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu-remediation show 12345678-1234-5678-90ab-cdef01234567 --display-script +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation.md b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation.md new file mode 100644 index 0000000000..8e24443bd5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu-remediation/dpu-remediation.md @@ -0,0 +1,54 @@ +# `nico-admin-cli dpu-remediation` + +_[Hardware commands](../../hardware.md) › **dpu-remediation**_ + +## NAME + +nico-admin-cli-dpu-remediation - Dpu Remediation handling + +## SYNOPSIS + +**nico-admin-cli dpu-remediation** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Dpu Remediation handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./dpu-remediation-create.md) | Create a remediation | +| [`approve`](./dpu-remediation-approve.md) | Approve a remediation | +| [`revoke`](./dpu-remediation-revoke.md) | Revoke a remediation | +| [`enable`](./dpu-remediation-enable.md) | Enable a remediation | +| [`disable`](./dpu-remediation-disable.md) | Disable a remediation | +| [`show`](./dpu-remediation-show.md) | Display remediation information | +| [`list-applied`](./dpu-remediation-list-applied.md) | Display information about applied remediations | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-agent-upgrade-policy.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-agent-upgrade-policy.md new file mode 100644 index 0000000000..740ba1a47e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-agent-upgrade-policy.md @@ -0,0 +1,62 @@ +# `nico-admin-cli dpu agent-upgrade-policy` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › **agent-upgrade-policy**_ + +## NAME + +nico-admin-cli-dpu-agent-upgrade-policy - Get or set forge-dpu-agent +upgrade policy + +## SYNOPSIS + +**nico-admin-cli dpu agent-upgrade-policy** \[**--set**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get or set forge-dpu-agent upgrade policy + +## OPTIONS + +**--set** *\* +\ +*Possible values:* + +- off + +- up-only + +- up-down + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu agent-upgrade-policy +nico-admin-cli dpu agent-upgrade-policy --set up-only +nico-admin-cli dpu agent-upgrade-policy --set up-down +nico-admin-cli dpu agent-upgrade-policy --set off +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-add.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-add.md new file mode 100644 index 0000000000..683cf5aef0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-add.md @@ -0,0 +1,97 @@ +# `nico-admin-cli dpu health-report add` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [health-report](./dpu-health-report.md) › **add**_ + +## NAME + +nico-admin-cli-dpu-health-report-add - Insert a health report source for +a DPU + +## SYNOPSIS + +**nico-admin-cli dpu health-report add** \[**--health-report**\] +\[**--template**\] \[**--message**\] \[**--replace**\] +\[**--print-only**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*DPU_ID*\> + +## DESCRIPTION + +Insert a health report source for a DPU + +## OPTIONS + +**--health-report** *\* +New health report as json + +**--template** *\* +Predefined Template name\ + +\ +*Possible values:* + +- host-update + +- internal-maintenance + +- out-for-repair + +- degraded + +- validation + +- suppress-external-alerting + +- mark-healthy + +- stop-reboot-for-automatic-recovery-from-state-machine + +- tenant-reported-issue + +- request-online-repair + +- request-repair + +**--message** *\* +Message to be filled in template. + +**--replace** +Replace the DPU health contribution with this source + +**--print-only** +Print the template that is going to be sent to carbide + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*DPU_ID*\> + +## Examples + +```sh +nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance +nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 --template out-for-repair --message "awaiting replacement part" +nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 --health-report '{"status":"Degraded"}' +nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance --replace +nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance --print-only +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-print-empty-template.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-print-empty-template.md new file mode 100644 index 0000000000..db46fe06cc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-print-empty-template.md @@ -0,0 +1,43 @@ +# `nico-admin-cli dpu health-report print-empty-template` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [health-report](./dpu-health-report.md) › **print-empty-template**_ + +## NAME + +nico-admin-cli-dpu-health-report-print-empty-template - Print an empty +health report template + +## SYNOPSIS + +**nico-admin-cli dpu health-report print-empty-template** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print an empty health report template + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-remove.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-remove.md new file mode 100644 index 0000000000..ba6609110f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-remove.md @@ -0,0 +1,53 @@ +# `nico-admin-cli dpu health-report remove` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [health-report](./dpu-health-report.md) › **remove**_ + +## NAME + +nico-admin-cli-dpu-health-report-remove - Remove a health report source +from a DPU + +## SYNOPSIS + +**nico-admin-cli dpu health-report remove** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*DPU_ID*\> +\<*REPORT_SOURCE*\> + +## DESCRIPTION + +Remove a health report source from a DPU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*DPU_ID*\> +\<*REPORT_SOURCE*\> + +## Examples + +```sh +nico-admin-cli dpu health-report remove 12345678-1234-5678-90ab-cdef01234567 internal-maintenance +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-show.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-show.md new file mode 100644 index 0000000000..46be71919a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report-show.md @@ -0,0 +1,51 @@ +# `nico-admin-cli dpu health-report show` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [health-report](./dpu-health-report.md) › **show**_ + +## NAME + +nico-admin-cli-dpu-health-report-show - List health report sources for a +DPU + +## SYNOPSIS + +**nico-admin-cli dpu health-report show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*DPU_ID*\> + +## DESCRIPTION + +List health report sources for a DPU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*DPU_ID*\> + +## Examples + +```sh +nico-admin-cli dpu health-report show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report.md new file mode 100644 index 0000000000..54a23e318c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-health-report.md @@ -0,0 +1,59 @@ +# `nico-admin-cli dpu health-report` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › **health-report**_ + +## NAME + +nico-admin-cli-dpu-health-report - Manage DPU health report sources + +## SYNOPSIS + +**nico-admin-cli dpu health-report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage DPU health report sources + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu health-report show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance +nico-admin-cli dpu health-report remove 12345678-1234-5678-90ab-cdef01234567 internal-maintenance +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./dpu-health-report-show.md) | List health report sources for a DPU | +| [`add`](./dpu-health-report-add.md) | Insert a health report source for a DPU | +| [`print-empty-template`](./dpu-health-report-print-empty-template.md) | Print an empty health report template | +| [`remove`](./dpu-health-report-remove.md) | Remove a health report source from a DPU | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-network-config.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-network-config.md new file mode 100644 index 0000000000..f371bc24a1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-network-config.md @@ -0,0 +1,52 @@ +# `nico-admin-cli dpu network config` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [network](./dpu-network.md) › **config**_ + +## NAME + +nico-admin-cli-dpu-network-config - Machine network configuration, used +by VPC. + +## SYNOPSIS + +**nico-admin-cli dpu network config** \<**--machine-id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Machine network configuration, used by VPC. + +## OPTIONS + +**--machine-id** *\* +DPU machine id + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu network config --machine-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-network-status.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-network-status.md new file mode 100644 index 0000000000..29b549bc60 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-network-status.md @@ -0,0 +1,42 @@ +# `nico-admin-cli dpu network status` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [network](./dpu-network.md) › **status**_ + +## NAME + +nico-admin-cli-dpu-network-status - Print network status of all machines + +## SYNOPSIS + +**nico-admin-cli dpu network status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print network status of all machines + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-network.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-network.md new file mode 100644 index 0000000000..b4fa719027 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-network.md @@ -0,0 +1,56 @@ +# `nico-admin-cli dpu network` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › **network**_ + +## NAME + +nico-admin-cli-dpu-network - Networking information + +## SYNOPSIS + +**nico-admin-cli dpu network** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Networking information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu network status +nico-admin-cli dpu network config --machine-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`status`](./dpu-network-status.md) | Print network status of all machines | +| [`config`](./dpu-network-config.md) | Machine network configuration, used by VPC. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-clear.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-clear.md new file mode 100644 index 0000000000..47f882b161 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-clear.md @@ -0,0 +1,55 @@ +# `nico-admin-cli dpu reprovision clear` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [reprovision](./dpu-reprovision.md) › **clear**_ + +## NAME + +nico-admin-cli-dpu-reprovision-clear - Clear the reprovisioning mode. + +## SYNOPSIS + +**nico-admin-cli dpu reprovision clear** \<**-i**\|**--id**\> +\[**-u**\|**--update-firmware**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Clear the reprovisioning mode. + +## OPTIONS + +**-i**, **--id** *\* +DPU Machine ID for which reprovisioning should be cleared, or host +machine id if all DPUs should be cleared. + +**-u**, **--update-firmware** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu reprovision clear --id abcdef01-2345-6789-abcd-ef0123456789 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-list.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-list.md new file mode 100644 index 0000000000..d8b2e1febd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-list.md @@ -0,0 +1,43 @@ +# `nico-admin-cli dpu reprovision list` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [reprovision](./dpu-reprovision.md) › **list**_ + +## NAME + +nico-admin-cli-dpu-reprovision-list - List all DPUs pending +reprovisioning. + +## SYNOPSIS + +**nico-admin-cli dpu reprovision list** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all DPUs pending reprovisioning. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-restart.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-restart.md new file mode 100644 index 0000000000..653d7f3913 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-restart.md @@ -0,0 +1,54 @@ +# `nico-admin-cli dpu reprovision restart` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [reprovision](./dpu-reprovision.md) › **restart**_ + +## NAME + +nico-admin-cli-dpu-reprovision-restart - Restart the DPU reprovision. + +## SYNOPSIS + +**nico-admin-cli dpu reprovision restart** \<**-i**\|**--id**\> +\[**-u**\|**--update-firmware**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Restart the DPU reprovision. + +## OPTIONS + +**-i**, **--id** *\* +Host Machine ID for which reprovisioning should be restarted. + +**-u**, **--update-firmware** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 --update-firmware +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-set.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-set.md new file mode 100644 index 0000000000..b6409d96b6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision-set.md @@ -0,0 +1,59 @@ +# `nico-admin-cli dpu reprovision set` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › [reprovision](./dpu-reprovision.md) › **set**_ + +## NAME + +nico-admin-cli-dpu-reprovision-set - Set the DPU in reprovisioning mode. + +## SYNOPSIS + +**nico-admin-cli dpu reprovision set** \<**-i**\|**--id**\> +\[**-u**\|**--update-firmware**\] \[**--update-message**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set the DPU in reprovisioning mode. + +## OPTIONS + +**-i**, **--id** *\* +DPU Machine ID for which reprovisioning is needed, or host machine id if +all DPUs should be reprovisioned. + +**-u**, **--update-firmware** +**--update-message** *\* +If set, a HostUpdateInProgress health alert will be applied to the host + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu reprovision set --id abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 --update-firmware --update-message "scheduled firmware refresh" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision.md new file mode 100644 index 0000000000..6bd78929a2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-reprovision.md @@ -0,0 +1,60 @@ +# `nico-admin-cli dpu reprovision` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › **reprovision**_ + +## NAME + +nico-admin-cli-dpu-reprovision - DPU Reprovisioning handling + +## SYNOPSIS + +**nico-admin-cli dpu reprovision** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +DPU Reprovisioning handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu reprovision list +nico-admin-cli dpu reprovision set --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli dpu reprovision restart --id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set`](./dpu-reprovision-set.md) | Set the DPU in reprovisioning mode. | +| [`clear`](./dpu-reprovision-clear.md) | Clear the reprovisioning mode. | +| [`list`](./dpu-reprovision-list.md) | List all DPUs pending reprovisioning. | +| [`restart`](./dpu-reprovision-restart.md) | Restart the DPU reprovision. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-status.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-status.md new file mode 100644 index 0000000000..1b6a56280a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-status.md @@ -0,0 +1,42 @@ +# `nico-admin-cli dpu status` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › **status**_ + +## NAME + +nico-admin-cli-dpu-status - View DPU Status + +## SYNOPSIS + +**nico-admin-cli dpu status** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +View DPU Status + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu-versions.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu-versions.md new file mode 100644 index 0000000000..58d4b3c072 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu-versions.md @@ -0,0 +1,52 @@ +# `nico-admin-cli dpu versions` + +_[Hardware commands](../../hardware.md) › [dpu](./dpu.md) › **versions**_ + +## NAME + +nico-admin-cli-dpu-versions - View DPU firmware status + +## SYNOPSIS + +**nico-admin-cli dpu versions** \[**-u**\|**--updates-only**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +View DPU firmware status + +## OPTIONS + +**-u**, **--updates-only** +Only show DPUs that need upgrades + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli dpu versions +nico-admin-cli dpu versions --updates-only +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/dpu/dpu.md b/docs/manuals/nico-admin-cli/commands/dpu/dpu.md new file mode 100644 index 0000000000..ab0cad007e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/dpu/dpu.md @@ -0,0 +1,53 @@ +# `nico-admin-cli dpu` + +_[Hardware commands](../../hardware.md) › **dpu**_ + +## NAME + +nico-admin-cli-dpu - DPU specific handling + +## SYNOPSIS + +**nico-admin-cli dpu** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +DPU specific handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`reprovision`](./dpu-reprovision.md) | DPU Reprovisioning handling | +| [`agent-upgrade-policy`](./dpu-agent-upgrade-policy.md) | Get or set forge-dpu-agent upgrade policy | +| [`versions`](./dpu-versions.md) | View DPU firmware status | +| [`status`](./dpu-status.md) | View DPU Status | +| [`network`](./dpu-network.md) | Networking information | +| [`health-report`](./dpu-health-report.md) | Manage DPU health report sources | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.md new file mode 100644 index 0000000000..eed5657db3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.md @@ -0,0 +1,171 @@ +# `nico-admin-cli expected-machine add` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **add**_ + +## NAME + +nico-admin-cli-expected-machine-add - Add expected machine + +## SYNOPSIS + +**nico-admin-cli expected-machine add** +\<**-a**\|**--bmc-mac-address**\> \<**-u**\|**--bmc-username**\> +\[**-p**\|**--bmc-password**\] \<**-s**\|**--chassis-serial-number**\> +\[**-d**\|**--fallback-dpu-serial-number**\] \[**--meta-name**\] +\[**--meta-description**\] \[**--label**\] \[**--sku-id**\] \[**--id**\] +\[**--host_nics**\] \[**--rack_id**\] +\[**--default_pause_ingestion_and_poweron**\] \[**--dpf-enabled**\] +\[**--extended**\] \[**--bmc-ip-address**\] +\[**--bmc-retain-credentials**\] \[**--dpu-mode**\] +\[**--disable-lockdown**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add expected machine + +## OPTIONS + +**-a**, **--bmc-mac-address** *\* +BMC MAC Address of the expected machine + +**-u**, **--bmc-username** *\* +BMC username of the expected machine + +**-p**, **--bmc-password** *\* +BMC password of the expected machine (optional; defaults to empty string +if not provided) + +**-s**, **--chassis-serial-number** *\* +Chassis serial number of the expected machine + +**-d**, **--fallback-dpu-serial-number** *\* +Serial number of the DPU attached to the expected machine. This option +should be used only as a last resort for ingesting those servers whose +BMC/Redfish do not report serial number of network devices. This option +can be repeated. + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Machines. If empty, the MachineId will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Machines + +**--label** *\* +A label that will be added as metadata for the newly created Machine. +The labels key and value must be separated by a : character. E.g. +DATACENTER:XYZ + +**--sku-id** *\* +A SKU ID that will be added for the newly created Machine. + +**--id** *\* +Optional unique ID to assign to the ExpectedMachine on create + +**--host_nics** *\* +Host NICs as a JSON array of ExpectedHostNic objects (fields: +mac_address, nic_type, fixed_ip, fixed_mask, fixed_gateway, primary) + +**--rack_id** *\* +Rack ID for this machine + +**--default_pause_ingestion_and_poweron** *\* +Optional flag to pause machines ingestion and power on. False - dont +pause, true - will pause it. The actual mutable state is stored in +explored_endpoints.\ + +\ +*Possible values:* + +- true + +- false + +**--dpf-enabled** *\* +DPF enable/disable for this machine. Default is updated as true.\ + +\ +*Possible values:* + +- true + +- false + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--bmc-ip-address** *\* +Static BMC IP (pre-allocates machine_interface for site explorer, same +as expected switches) + +**--bmc-retain-credentials** *\* +When true, site-explorer skips BMC password rotation and stores +factory-default credentials in Vault as-is\ + +\ +*Possible values:* + +- true + +- false + +**--dpu-mode** *\* +Per-host DPU operating mode. \`dpu-mode\` (default): DPUs are managed by +NICo; \`nic-mode\`: DPU hardware present but treated as a plain NIC; +\`no-dpu\`: no DPU hardware at all. Unset defers to the site-wide +\`\[site_explorer\] dpu_mode\` setting (which itself falls back to +\`dpu-mode\` when not set).\ + +\ +*Possible values:* + +- unspecified + +- dpu-mode + +- nic-mode + +- no-dpu + +**--disable-lockdown** *\* +If true, do not lock down the server as part of lifecycle management +within the state machine. If unset or false, preserve the default +behavior of locking down the server after configuring the BIOS.\ + +\ +*Possible values:* + +- true + +- false + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 +nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 --meta-name MyMachine --label DATACENTER:XYZ --sku-id DGX-H100-640GB +nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 --bmc-ip-address 192.0.2.20 +nico-admin-cli expected-machine add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --chassis-serial-number sample_serial-1 --dpu-mode nic-mode +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-delete.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-delete.md new file mode 100644 index 0000000000..d6dc9dd9f3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-delete.md @@ -0,0 +1,56 @@ +# `nico-admin-cli expected-machine delete` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **delete**_ + +## NAME + +nico-admin-cli-expected-machine-delete - Delete expected machine + +## SYNOPSIS + +**nico-admin-cli expected-machine delete** \[**--id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*BMC_MAC_ADDRESS*\] + +## DESCRIPTION + +Delete expected machine + +## OPTIONS + +**--id** *\* +ID (UUID) of the expected machine to delete. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*BMC_MAC_ADDRESS*\] +BMC MAC address of the expected machine to delete. + +## Examples + +```sh +nico-admin-cli expected-machine delete 00:11:22:33:44:55 +nico-admin-cli expected-machine delete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-erase.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-erase.md new file mode 100644 index 0000000000..100cb8c50d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-erase.md @@ -0,0 +1,51 @@ +# `nico-admin-cli expected-machine erase` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **erase**_ + +## NAME + +nico-admin-cli-expected-machine-erase - Erase all expected machines + +## SYNOPSIS + +**nico-admin-cli expected-machine erase** \[**--confirm**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Erase all expected machines + +## OPTIONS + +**--confirm** +Confirm that you want to erase all records. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-machine erase --confirm +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-patch.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-patch.md new file mode 100644 index 0000000000..49d10d9fb2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-patch.md @@ -0,0 +1,176 @@ +# `nico-admin-cli expected-machine patch` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **patch**_ + +## NAME + +nico-admin-cli-expected-machine-patch - Patch expected machine (partial +update, preserves unprovided fields). + +## SYNOPSIS + +**nico-admin-cli expected-machine patch** +\[**-a**\|**--bmc-mac-address**\] \[**--id**\] +\[**-u**\|**--bmc-username**\] \[**-p**\|**--bmc-password**\] +\[**-s**\|**--chassis-serial-number**\] +\[**-d**\|**--fallback-dpu-serial-number**\] \[**--meta-name**\] +\[**--meta-description**\] \[**--label**\] \[**--sku-id**\] +\[**--rack-id**\] \[**--default_pause_ingestion_and_poweron**\] +\[**--dpf-enabled**\] \[**--bmc-ip-address**\] \[**--extended**\] +\[**--bmc-retain-credentials**\] \[**--dpu-mode**\] +\[**--disable-lockdown**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Patch expected machine (partial update, preserves unprovided fields). + +Only the fields provided in the command will be updated. All other +fields remain unchanged. + +Examples: \# Update only SKU, preserve all other fields including +metadata nico-admin-cli expected-machine patch --bmc-mac-address +1a:1b:1c:1d:1e:1f --sku-id new_sku + +\# Update only labels, preserve name and description nico-admin-cli +expected-machine patch --bmc-mac-address 1a:1b:1c:1d:1e:1f \\ --sku-id +sku123 --label env:prod --label team:platform + +## OPTIONS + +**-a**, **--bmc-mac-address** *\* +BMC MAC Address of the expected machine + +**--id** *\* +ID (UUID) of the expected machine to patch. + +**-u**, **--bmc-username** *\* +BMC username of the expected machine + +**-p**, **--bmc-password** *\* +BMC password of the expected machine + +**-s**, **--chassis-serial-number** *\* +Chassis serial number of the expected machine + +**-d**, **--fallback-dpu-serial-number** *\* +Serial number of the DPU attached to the expected machine. This option +should be used only as a last resort for ingesting those servers whose +BMC/Redfish do not report serial number of network devices. This option +can be repeated. + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Machines. If empty, the MachineId will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Machines + +**--label** *\* +A label that will be added as metadata for the newly created Machine. +The labels key and value must be separated by a : character + +**--sku-id** *\* +A SKU ID that will be added for the newly created Machine. + +**--rack-id** *\* +A RACK ID that will be added for the newly created Machine. + +**--default_pause_ingestion_and_poweron** *\* +Optional flag to pause machines ingestion and power on. False - dont +pause, true - will pause it. The actual mutable state is stored in +explored_endpoints.\ + +\ +*Possible values:* + +- true + +- false + +**--dpf-enabled** *\* +DPF enable/disable for this machine. Default is updated as true.\ + +\ +*Possible values:* + +- true + +- false + +**--bmc-ip-address** *\* +Static BMC IP (updates pre-allocated machine_interface when safe, same +as expected switches) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--bmc-retain-credentials** *\* +When true, site-explorer skips BMC password rotation and stores +factory-default credentials in Vault as-is\ + +\ +*Possible values:* + +- true + +- false + +**--dpu-mode** *\* +Per-host DPU operating mode. \`dpu-mode\` (default): DPUs are managed by +NICo; \`nic-mode\`: DPU hardware present but treated as a plain NIC; +\`no-dpu\`: no DPU hardware at all. Unset preserves the existing +per-host value.\ + +\ +*Possible values:* + +- unspecified + +- dpu-mode + +- nic-mode + +- no-dpu + +**--disable-lockdown** *\* +If true, do not lock down the server as part of lifecycle management +within the state machine. If unset or false, preserve the default +behavior of locking down the server after configuring the BIOS.\ + +\ +*Possible values:* + +- true + +- false + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 --sku-id DGX-H100-640GB +nico-admin-cli expected-machine patch --id 12345678-1234-5678-90ab-cdef01234567 --sku-id DGX-H100-640GB +nico-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mynewpassword +nico-admin-cli expected-machine patch --bmc-mac-address 00:11:22:33:44:55 --dpu-mode no-dpu +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-replace-all.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-replace-all.md new file mode 100644 index 0000000000..63ab767fd2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-replace-all.md @@ -0,0 +1,61 @@ +# `nico-admin-cli expected-machine replace-all` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **replace-all**_ + +## NAME + +nico-admin-cli-expected-machine-replace-all - Replace all entries in the +expected machines table with the entries from an inputted json file. + +## SYNOPSIS + +**nico-admin-cli expected-machine replace-all** +\<**-f**\|**--filename**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Replace all entries in the expected machines table with the entries from +an inputted json file. + +Example json file: { "expected_machines": \[ { "bmc_mac_address": +"1a:1b:1c:1d:1e:1f", "bmc_username": "user", "bmc_password": "pass", +"chassis_serial_number": "sample_serial-1" }, { "bmc_mac_address": +"2a:2b:2c:2d:2e:2f", "bmc_username": "user", "bmc_password": "pass", +"chassis_serial_number": "sample_serial-2", +"fallback_dpu_serial_numbers": \["MT020100000003"\], "metadata": { +"name": "MyMachine", "description": "My Machine", "labels": \[{"key": +"ABC", "value": "DEF"}\] } } \] } + +## OPTIONS + +**-f**, **--filename** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-machine replace-all --filename ./expected-machines.json +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-show.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-show.md new file mode 100644 index 0000000000..7c934e5b27 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-show.md @@ -0,0 +1,56 @@ +# `nico-admin-cli expected-machine show` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **show**_ + +## NAME + +nico-admin-cli-expected-machine-show - Show expected machine data + +## SYNOPSIS + +**nico-admin-cli expected-machine show** \[**--id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*BMC_MAC_ADDRESS*\] + +## DESCRIPTION + +Show expected machine data + +## OPTIONS + +**--id** *\* +ID (UUID) of the expected machine to show. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*BMC_MAC_ADDRESS*\] +BMC MAC address of the expected machine to show. Leave unset for all. + +## Examples + +```sh +nico-admin-cli expected-machine show +nico-admin-cli expected-machine show 00:11:22:33:44:55 +nico-admin-cli expected-machine show --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-update.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-update.md new file mode 100644 index 0000000000..658365cb8b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-update.md @@ -0,0 +1,64 @@ +# `nico-admin-cli expected-machine update` + +_[Tenant commands](../../tenant.md) › [expected-machine](./expected-machine.md) › **update**_ + +## NAME + +nico-admin-cli-expected-machine-update - Update expected machine from +JSON file (full replacement, consistent with API). + +## SYNOPSIS + +**nico-admin-cli expected-machine update** \<**-f**\|**--filename**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Update expected machine from JSON file (full replacement, consistent +with API). + +All fields from the JSON file will completely replace the existing +record. This allows clearing metadata fields by providing empty values. + +Example json file: { "bmc_mac_address": "1a:1b:1c:1d:1e:1f", +"bmc_username": "user", "bmc_password": "pass", "chassis_serial_number": +"sample_serial-1", "fallback_dpu_serial_numbers": \["MT020100000003"\], +"metadata": { "name": "MyMachine", "description": "My Machine", +"labels": \[{"key": "ABC", "value": "DEF"}\] }, "sku_id": "sku_id_123" } + +Usage: nico-admin-cli expected-machine update --filename machine.json + +## OPTIONS + +**-f**, **--filename** *\* +Path to JSON file containing the expected machine data + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-machine update --filename ./machine.json +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine.md b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine.md new file mode 100644 index 0000000000..788cbf0f75 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine.md @@ -0,0 +1,54 @@ +# `nico-admin-cli expected-machine` + +_[Tenant commands](../../tenant.md) › **expected-machine**_ + +## NAME + +nico-admin-cli-expected-machine - Expected machine handling + +## SYNOPSIS + +**nico-admin-cli expected-machine** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Expected machine handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./expected-machine-show.md) | Show expected machine data | +| [`add`](./expected-machine-add.md) | Add expected machine | +| [`delete`](./expected-machine-delete.md) | Delete expected machine | +| [`patch`](./expected-machine-patch.md) | Patch expected machine (partial update, preserves unprovided fields). | +| [`update`](./expected-machine-update.md) | Update expected machine from JSON file (full replacement, consistent with API). | +| [`replace-all`](./expected-machine-replace-all.md) | Replace all entries in the expected machines table with the entries from an inputted json file. | +| [`erase`](./expected-machine-erase.md) | Erase all expected machines | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-add.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-add.md new file mode 100644 index 0000000000..50ab8466e3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-add.md @@ -0,0 +1,100 @@ +# `nico-admin-cli expected-power-shelf add` + +_[Tenant commands](../../tenant.md) › [expected-power-shelf](./expected-power-shelf.md) › **add**_ + +## NAME + +nico-admin-cli-expected-power-shelf-add - Add expected power shelf + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf add** +\<**-a**\|**--bmc-mac-address**\> \<**-u**\|**--bmc-username**\> +\<**-p**\|**--bmc-password**\> \<**-s**\|**--shelf-serial-number**\> +\[**--meta-name**\] \[**--meta-description**\] \[**--label**\] +\[**--host_name**\] \[**--rack_id**\] \[**--bmc-ip-address**\] +\[**--bmc-retain-credentials**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Add expected power shelf + +## OPTIONS + +**-a**, **--bmc-mac-address** *\* +BMC MAC Address of the expected power shelf + +**-u**, **--bmc-username** *\* +BMC username of the expected power shelf + +**-p**, **--bmc-password** *\* +BMC password of the expected power shelf + +**-s**, **--shelf-serial-number** *\* +Serial number of the expected power shelf + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Power Shelf. If empty, the Power Shelf Id will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Power Shelf + +**--label** *\* +A label that will be added as metadata for the newly created Power +Shelf. The labels key and value must be separated by a : character. E.g. +DATACENTER:XYZ + +**--host_name** *\* +Host name of the power shelf + +**--rack_id** *\* +Rack ID for this machine + +**--bmc-ip-address** *\* +BMC IP address of the power shelf + +**--bmc-retain-credentials** *\* +When true, site-explorer skips BMC password rotation and stores +factory-default credentials in Vault as-is\ + +\ +*Possible values:* + +- true + +- false + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --shelf-serial-number DGX-H100-640GB +nico-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --shelf-serial-number DGX-H100-640GB --rack_id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli expected-power-shelf add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --shelf-serial-number DGX-H100-640GB --bmc-ip-address 192.0.2.20 --meta-name shelf-01 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-delete.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-delete.md new file mode 100644 index 0000000000..4e748445a7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-delete.md @@ -0,0 +1,56 @@ +# `nico-admin-cli expected-power-shelf delete` + +_[Tenant commands](../../tenant.md) › [expected-power-shelf](./expected-power-shelf.md) › **delete**_ + +## NAME + +nico-admin-cli-expected-power-shelf-delete - Delete expected power shelf + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf delete** \[**--id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*BMC_MAC_ADDRESS*\] + +## DESCRIPTION + +Delete expected power shelf + +## OPTIONS + +**--id** *\* +ID (UUID) of the expected power shelf to delete. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*BMC_MAC_ADDRESS*\] +BMC MAC address of expected power shelf to delete. + +## Examples + +```sh +nico-admin-cli expected-power-shelf delete 00:11:22:33:44:55 +nico-admin-cli expected-power-shelf delete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-erase.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-erase.md new file mode 100644 index 0000000000..c8e641d69f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-erase.md @@ -0,0 +1,52 @@ +# `nico-admin-cli expected-power-shelf erase` + +_[Tenant commands](../../tenant.md) › [expected-power-shelf](./expected-power-shelf.md) › **erase**_ + +## NAME + +nico-admin-cli-expected-power-shelf-erase - Erase all expected power +shelves + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf erase** \[**--confirm**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Erase all expected power shelves + +## OPTIONS + +**--confirm** +Confirm that you want to erase all records. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-power-shelf erase --confirm +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-replace-all.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-replace-all.md new file mode 100644 index 0000000000..b44c77f760 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-replace-all.md @@ -0,0 +1,51 @@ +# `nico-admin-cli expected-power-shelf replace-all` + +_[Tenant commands](../../tenant.md) › [expected-power-shelf](./expected-power-shelf.md) › **replace-all**_ + +## NAME + +nico-admin-cli-expected-power-shelf-replace-all - Replace all expected +power shelves + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf replace-all** +\<**-f**\|**--filename**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Replace all expected power shelves + +## OPTIONS + +**-f**, **--filename** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-power-shelf replace-all --filename ./power-shelves.json +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-show.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-show.md new file mode 100644 index 0000000000..de14959d40 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-show.md @@ -0,0 +1,58 @@ +# `nico-admin-cli expected-power-shelf show` + +_[Tenant commands](../../tenant.md) › [expected-power-shelf](./expected-power-shelf.md) › **show**_ + +## NAME + +nico-admin-cli-expected-power-shelf-show - Show expected power shelf + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf show** \[**--id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*BMC_MAC_ADDRESS*\] + +## DESCRIPTION + +Show expected power shelf + +## OPTIONS + +**--id** *\* +ID (UUID) of the expected power shelf to show. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*BMC_MAC_ADDRESS*\] +BMC MAC address of the expected power shelf to show. Leave unset for +all. + +## Examples + +```sh +nico-admin-cli expected-power-shelf show +nico-admin-cli expected-power-shelf show 00:11:22:33:44:55 +nico-admin-cli expected-power-shelf show --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-update.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-update.md new file mode 100644 index 0000000000..80f904b79f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf-update.md @@ -0,0 +1,102 @@ +# `nico-admin-cli expected-power-shelf update` + +_[Tenant commands](../../tenant.md) › [expected-power-shelf](./expected-power-shelf.md) › **update**_ + +## NAME + +nico-admin-cli-expected-power-shelf-update - Update expected power shelf + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf update** +\[**-a**\|**--bmc-mac-address**\] \[**--id**\] +\[**-u**\|**--bmc-username**\] \[**-p**\|**--bmc-password**\] +\[**-s**\|**--shelf-serial-number**\] \[**--meta-name**\] +\[**--meta-description**\] \[**--label**\] \[**--host_name**\] +\[**--rack_id**\] \[**--bmc-ip-address**\] +\[**--bmc-retain-credentials**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update expected power shelf + +## OPTIONS + +**-a**, **--bmc-mac-address** *\* +BMC MAC Address of the expected power shelf + +**--id** *\* +ID (UUID) of the expected power shelf to update. + +**-u**, **--bmc-username** *\* +BMC username of the expected power shelf + +**-p**, **--bmc-password** *\* +BMC password of the expected power shelf + +**-s**, **--shelf-serial-number** *\* +Chassis serial number of the expected power shelf + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Power Shelves. If empty, the Power Shelf Id will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Power Shelves + +**--label** *\* +A label that will be added as metadata for the newly created Machine. +The labels key and value must be separated by a : character + +**--host_name** *\* +Host name of the power shelf + +**--rack_id** *\* +Rack ID for this power shelf + +**--bmc-ip-address** *\* +BMC IP address of the power shelf + +**--bmc-retain-credentials** *\* +When true, site-explorer skips BMC password rotation and stores +factory-default credentials in Vault as-is\ + +\ +*Possible values:* + +- true + +- false + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-power-shelf update --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mynewpassword +nico-admin-cli expected-power-shelf update --id 12345678-1234-5678-90ab-cdef01234567 --shelf-serial-number DGX-H100-640GB +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf.md b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf.md new file mode 100644 index 0000000000..0cafcced6e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-power-shelf/expected-power-shelf.md @@ -0,0 +1,53 @@ +# `nico-admin-cli expected-power-shelf` + +_[Tenant commands](../../tenant.md) › **expected-power-shelf**_ + +## NAME + +nico-admin-cli-expected-power-shelf - Expected power shelf handling + +## SYNOPSIS + +**nico-admin-cli expected-power-shelf** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Expected power shelf handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./expected-power-shelf-show.md) | Show expected power shelf | +| [`add`](./expected-power-shelf-add.md) | Add expected power shelf | +| [`delete`](./expected-power-shelf-delete.md) | Delete expected power shelf | +| [`update`](./expected-power-shelf-update.md) | Update expected power shelf | +| [`replace-all`](./expected-power-shelf-replace-all.md) | Replace all expected power shelves | +| [`erase`](./expected-power-shelf-erase.md) | Erase all expected power shelves | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-add.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-add.md new file mode 100644 index 0000000000..e2a14ff12c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-add.md @@ -0,0 +1,70 @@ +# `nico-admin-cli expected-rack add` + +_[Tenant commands](../../tenant.md) › [expected-rack](./expected-rack.md) › **add**_ + +## NAME + +nico-admin-cli-expected-rack-add - Add expected rack + +## SYNOPSIS + +**nico-admin-cli expected-rack add** \[**--meta-name**\] +\[**--meta-description**\] \[**--label**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK_ID*\> +\<*RACK_PROFILE_ID*\> + +## DESCRIPTION + +Add expected rack + +## OPTIONS + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Rack. If empty, the Rack Id will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Rack + +**--label** *\* +A label that will be added as metadata for the newly created Rack. The +labels key and value must be separated by a : character. E.g. +DATACENTER:XYZ + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID of the expected rack + +\<*RACK_PROFILE_ID*\> +Rack profile ID of the expected rack + +## Examples + +```sh +nico-admin-cli expected-rack add 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli expected-rack add 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 --meta-name rack-01 --label DATACENTER:XYZ +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-delete.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-delete.md new file mode 100644 index 0000000000..c568c1be8f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli expected-rack delete` + +_[Tenant commands](../../tenant.md) › [expected-rack](./expected-rack.md) › **delete**_ + +## NAME + +nico-admin-cli-expected-rack-delete - Delete expected rack + +## SYNOPSIS + +**nico-admin-cli expected-rack delete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK_ID*\> + +## DESCRIPTION + +Delete expected rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID of expected rack to delete. + +## Examples + +```sh +nico-admin-cli expected-rack delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-erase.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-erase.md new file mode 100644 index 0000000000..20ea24bfbe --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-erase.md @@ -0,0 +1,51 @@ +# `nico-admin-cli expected-rack erase` + +_[Tenant commands](../../tenant.md) › [expected-rack](./expected-rack.md) › **erase**_ + +## NAME + +nico-admin-cli-expected-rack-erase - Erase all expected racks + +## SYNOPSIS + +**nico-admin-cli expected-rack erase** \[**--confirm**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Erase all expected racks + +## OPTIONS + +**--confirm** +Confirm that you want to erase all records. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-rack erase --confirm +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-replace-all.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-replace-all.md new file mode 100644 index 0000000000..1bdd1deeb7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-replace-all.md @@ -0,0 +1,49 @@ +# `nico-admin-cli expected-rack replace-all` + +_[Tenant commands](../../tenant.md) › [expected-rack](./expected-rack.md) › **replace-all**_ + +## NAME + +nico-admin-cli-expected-rack-replace-all - Replace all expected racks + +## SYNOPSIS + +**nico-admin-cli expected-rack replace-all** \<**-f**\|**--filename**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Replace all expected racks + +## OPTIONS + +**-f**, **--filename** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-rack replace-all --filename ./racks.json +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-show.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-show.md new file mode 100644 index 0000000000..0dbde03440 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli expected-rack show` + +_[Tenant commands](../../tenant.md) › [expected-rack](./expected-rack.md) › **show**_ + +## NAME + +nico-admin-cli-expected-rack-show - Show expected rack + +## SYNOPSIS + +**nico-admin-cli expected-rack show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*RACK_ID*\] + +## DESCRIPTION + +Show expected rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*RACK_ID*\] +Rack ID of the expected rack to show. Leave unset for all. + +## Examples + +```sh +nico-admin-cli expected-rack show +nico-admin-cli expected-rack show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-update.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-update.md new file mode 100644 index 0000000000..be21028d52 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack-update.md @@ -0,0 +1,69 @@ +# `nico-admin-cli expected-rack update` + +_[Tenant commands](../../tenant.md) › [expected-rack](./expected-rack.md) › **update**_ + +## NAME + +nico-admin-cli-expected-rack-update - Update expected rack + +## SYNOPSIS + +**nico-admin-cli expected-rack update** \[**--rack-profile-id**\] +\[**--meta-name**\] \[**--meta-description**\] \[**--label**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*RACK_ID*\> + +## DESCRIPTION + +Update expected rack + +## OPTIONS + +**--rack-profile-id** *\* +Rack profile ID of the expected rack + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Rack. If empty, the Rack Id will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Rack + +**--label** *\* +A label that will be added as metadata for the newly created Rack. The +labels key and value must be separated by a : character + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID of the expected rack + +## Examples + +```sh +nico-admin-cli expected-rack update 12345678-1234-5678-90ab-cdef01234567 --rack-profile-id abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli expected-rack update 12345678-1234-5678-90ab-cdef01234567 --rack-profile-id abcdef01-2345-6789-abcd-ef0123456789 --meta-name rack-01 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack.md b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack.md new file mode 100644 index 0000000000..489f2f90ea --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-rack/expected-rack.md @@ -0,0 +1,53 @@ +# `nico-admin-cli expected-rack` + +_[Tenant commands](../../tenant.md) › **expected-rack**_ + +## NAME + +nico-admin-cli-expected-rack - Expected rack handling + +## SYNOPSIS + +**nico-admin-cli expected-rack** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Expected rack handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./expected-rack-show.md) | Show expected rack | +| [`add`](./expected-rack-add.md) | Add expected rack | +| [`delete`](./expected-rack-delete.md) | Delete expected rack | +| [`update`](./expected-rack-update.md) | Update expected rack | +| [`replace-all`](./expected-rack-replace-all.md) | Replace all expected racks | +| [`erase`](./expected-rack-erase.md) | Erase all expected racks | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-add.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-add.md new file mode 100644 index 0000000000..e92f8178e4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-add.md @@ -0,0 +1,112 @@ +# `nico-admin-cli expected-switch add` + +_[Tenant commands](../../tenant.md) › [expected-switch](./expected-switch.md) › **add**_ + +## NAME + +nico-admin-cli-expected-switch-add - Add expected switch + +## SYNOPSIS + +**nico-admin-cli expected-switch add** \<**-a**\|**--bmc-mac-address**\> +\<**-u**\|**--bmc-username**\> \<**-p**\|**--bmc-password**\> +\<**-s**\|**--switch-serial-number**\> \[**--nvos-mac-address**\] +\[**--nvos-username**\] \[**--nvos-password**\] \[**--meta-name**\] +\[**--meta-description**\] \[**--label**\] \[**--rack_id**\] +\[**--bmc-ip-address**\] \[**--nvos-ip-address**\] +\[**--bmc-retain-credentials**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Add expected switch + +## OPTIONS + +**-a**, **--bmc-mac-address** *\* +BMC MAC Address of the expected switch + +**-u**, **--bmc-username** *\* +BMC username of the expected switch + +**-p**, **--bmc-password** *\* +BMC password of the expected switch + +**-s**, **--switch-serial-number** *\* +Chassis serial number of the expected switch + +**--nvos-mac-address** *\* +NVOS MAC address(es) of the expected switch + +**--nvos-username** *\* +NVOS username of the expected switch + +**--nvos-password** *\* +NVOS password of the expected switch + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Switches. If empty, the SwitchId will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Machines + +**--label** *\* +A label that will be added as metadata for the newly created Machine. +The labels key and value must be separated by a : character. E.g. +DATACENTER:XYZ + +**--rack_id** *\* +Rack ID for this machine + +**--bmc-ip-address** *\* +BMC IP address of the expected switch + +**--nvos-ip-address** *\* +Static IP for the single wired NVOS port. Requires exactly one +--nvos-mac-address + +**--bmc-retain-credentials** *\* +When true, site-explorer skips BMC password rotation and stores +factory-default credentials in Vault as-is\ + +\ +*Possible values:* + +- true + +- false + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB +nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB --rack_id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB --nvos-mac-address aa:bb:cc:dd:ee:ff --nvos-username admin --nvos-password mypassword --nvos-ip-address 192.0.2.10 +nico-admin-cli expected-switch add --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mypassword --switch-serial-number DGX-H100-640GB --meta-name spine-01 --label DATACENTER:XYZ +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-delete.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-delete.md new file mode 100644 index 0000000000..7a895322c2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-delete.md @@ -0,0 +1,56 @@ +# `nico-admin-cli expected-switch delete` + +_[Tenant commands](../../tenant.md) › [expected-switch](./expected-switch.md) › **delete**_ + +## NAME + +nico-admin-cli-expected-switch-delete - Delete expected switch + +## SYNOPSIS + +**nico-admin-cli expected-switch delete** \[**--id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\[*BMC_MAC_ADDRESS*\] + +## DESCRIPTION + +Delete expected switch + +## OPTIONS + +**--id** *\* +ID (UUID) of the expected switch to delete. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*BMC_MAC_ADDRESS*\] +BMC MAC address of expected switch to delete. + +## Examples + +```sh +nico-admin-cli expected-switch delete 00:11:22:33:44:55 +nico-admin-cli expected-switch delete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-erase.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-erase.md new file mode 100644 index 0000000000..ad8ea3c3de --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-erase.md @@ -0,0 +1,51 @@ +# `nico-admin-cli expected-switch erase` + +_[Tenant commands](../../tenant.md) › [expected-switch](./expected-switch.md) › **erase**_ + +## NAME + +nico-admin-cli-expected-switch-erase - Erase all expected switches + +## SYNOPSIS + +**nico-admin-cli expected-switch erase** \[**--confirm**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Erase all expected switches + +## OPTIONS + +**--confirm** +Confirm that you want to erase all records. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-switch erase --confirm +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-replace-all.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-replace-all.md new file mode 100644 index 0000000000..adfb97f7b7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-replace-all.md @@ -0,0 +1,51 @@ +# `nico-admin-cli expected-switch replace-all` + +_[Tenant commands](../../tenant.md) › [expected-switch](./expected-switch.md) › **replace-all**_ + +## NAME + +nico-admin-cli-expected-switch-replace-all - Replace all expected +switches + +## SYNOPSIS + +**nico-admin-cli expected-switch replace-all** +\<**-f**\|**--filename**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Replace all expected switches + +## OPTIONS + +**-f**, **--filename** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-switch replace-all --filename ./switches.json +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-show.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-show.md new file mode 100644 index 0000000000..1d7d5fb610 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-show.md @@ -0,0 +1,56 @@ +# `nico-admin-cli expected-switch show` + +_[Tenant commands](../../tenant.md) › [expected-switch](./expected-switch.md) › **show**_ + +## NAME + +nico-admin-cli-expected-switch-show - Show expected switch + +## SYNOPSIS + +**nico-admin-cli expected-switch show** \[**--id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*BMC_MAC_ADDRESS*\] + +## DESCRIPTION + +Show expected switch + +## OPTIONS + +**--id** *\* +ID (UUID) of the expected switch to show. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*BMC_MAC_ADDRESS*\] +BMC MAC address of the expected switch to show. Leave unset for all. + +## Examples + +```sh +nico-admin-cli expected-switch show +nico-admin-cli expected-switch show 00:11:22:33:44:55 +nico-admin-cli expected-switch show --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-update.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-update.md new file mode 100644 index 0000000000..447332b9cd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch-update.md @@ -0,0 +1,114 @@ +# `nico-admin-cli expected-switch update` + +_[Tenant commands](../../tenant.md) › [expected-switch](./expected-switch.md) › **update**_ + +## NAME + +nico-admin-cli-expected-switch-update - Update expected switch + +## SYNOPSIS + +**nico-admin-cli expected-switch update** +\[**-a**\|**--bmc-mac-address**\] \[**--id**\] +\[**-u**\|**--bmc-username**\] \[**-p**\|**--bmc-password**\] +\[**-s**\|**--switch-serial-number**\] \[**--nvos-mac-address**\] +\[**--nvos-username**\] \[**--nvos-password**\] \[**--meta-name**\] +\[**--meta-description**\] \[**--label**\] \[**--rack_id**\] +\[**--bmc-ip-address**\] \[**--extended**\] \[**--nvos-ip-address**\] +\[**--bmc-retain-credentials**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update expected switch + +## OPTIONS + +**-a**, **--bmc-mac-address** *\* +BMC MAC Address of the expected switch + +**--id** *\* +ID (UUID) of the expected switch to update. + +**-u**, **--bmc-username** *\* +BMC username of the expected switch + +**-p**, **--bmc-password** *\* +BMC password of the expected switch + +**-s**, **--switch-serial-number** *\* +Switch serial number of the expected switch + +**--nvos-mac-address** *\* +NVOS MAC address(es) of the expected switch + +**--nvos-username** *\* +NVOS username of the expected switch + +**--nvos-password** *\* +NVOS password of the expected switch + +**--meta-name** *\* +The name that should be used as part of the Metadata for newly created +Switches. If empty, the SwitchId will be used + +**--meta-description** *\* +The description that should be used as part of the Metadata for newly +created Machines + +**--label** *\* +A label that will be added as metadata for the newly created Machine. +The labels key and value must be separated by a : character + +**--rack_id** *\* +Rack ID for this switch + +**--bmc-ip-address** *\* +BMC IP address of the expected switch + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--nvos-ip-address** *\* +Static IP for the single wired NVOS port. Requires exactly one +--nvos-mac-address + +**--bmc-retain-credentials** *\* +When true, site-explorer skips BMC password rotation and stores +factory-default credentials in Vault as-is\ + +\ +*Possible values:* + +- true + +- false + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli expected-switch update --bmc-mac-address 00:11:22:33:44:55 --bmc-username admin --bmc-password mynewpassword +nico-admin-cli expected-switch update --id 12345678-1234-5678-90ab-cdef01234567 --switch-serial-number DGX-H100-640GB +nico-admin-cli expected-switch update --bmc-mac-address 00:11:22:33:44:55 --nvos-username admin --nvos-password mynewpassword +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch.md b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch.md new file mode 100644 index 0000000000..5ade3ffde7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/expected-switch/expected-switch.md @@ -0,0 +1,53 @@ +# `nico-admin-cli expected-switch` + +_[Tenant commands](../../tenant.md) › **expected-switch**_ + +## NAME + +nico-admin-cli-expected-switch - Expected switch handling + +## SYNOPSIS + +**nico-admin-cli expected-switch** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Expected switch handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./expected-switch-show.md) | Show expected switch | +| [`add`](./expected-switch-add.md) | Add expected switch | +| [`delete`](./expected-switch-delete.md) | Delete expected switch | +| [`update`](./expected-switch-update.md) | Update expected switch | +| [`replace-all`](./expected-switch-replace-all.md) | Replace all expected switches | +| [`erase`](./expected-switch-erase.md) | Erase all expected switches | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-create.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-create.md new file mode 100644 index 0000000000..40675ca5b7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-create.md @@ -0,0 +1,91 @@ +# `nico-admin-cli extension-service create` + +_[Tenant commands](../../tenant.md) › [extension-service](./extension-service.md) › **create**_ + +## NAME + +nico-admin-cli-extension-service-create - Create an extension service + +## SYNOPSIS + +**nico-admin-cli extension-service create** \[**-i**\|**--id**\] +\<**-n**\|**--name**\> \<**-t**\|**--type**\> \[**--description**\] +\[**--tenant-organization-id**\] \<**-d**\|**--data**\> +\[**--registry-url**\] \[**--username**\] \[**--password**\] +\[**--observability**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Create an extension service + +## OPTIONS + +**-i**, **--id** *\* +The extension service ID to create (optional) + +**-n**, **--name** *\* +Extension service name + +**-t**, **--type** *\* +Extension service type\ + +\ +*Possible values:* + +- kubernetes-pod + +**--description** *\* +Extension service description (optional) + +**--tenant-organization-id** *\* +Tenant organization ID + +**-d**, **--data** *\* +Extension service data + +**--registry-url** *\* +Registry URL for the service credential (optional) + +**--username** *\* +Username for the service credential (optional) + +**--password** *\* +Password for the service credential (optional) + +**--observability** *\* +JSON array containing a defined set of extension observability configs +(optional) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli extension-service create --name my-service --type kubernetes-pod --data '{"image":"my-registry/my-service:1.0"}' +nico-admin-cli extension-service create --id 12345678-1234-5678-90ab-cdef01234567 --name my-service --type kubernetes-pod --data '{"image":"my-registry/my-service:1.0"}' --description "Front-end telemetry agent" +nico-admin-cli extension-service create --name my-service --type kubernetes-pod --data '{"image":"my-registry/my-service:1.0"}' --tenant-organization-id fds34511233a +nico-admin-cli extension-service create --name my-service --type kubernetes-pod --data '{"image":"my-registry/my-service:1.0"}' --registry-url my-registry.example.com --username admin --password mypassword +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-delete.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-delete.md new file mode 100644 index 0000000000..76959e2566 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-delete.md @@ -0,0 +1,56 @@ +# `nico-admin-cli extension-service delete` + +_[Tenant commands](../../tenant.md) › [extension-service](./extension-service.md) › **delete**_ + +## NAME + +nico-admin-cli-extension-service-delete - Delete an extension service + +## SYNOPSIS + +**nico-admin-cli extension-service delete** \<**-i**\|**--id**\> +\[**-v**\|**--versions**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Delete an extension service + +## OPTIONS + +**-i**, **--id** *\* +The extension service ID to delete + +**-v**, **--versions** *\* +Version strings to delete (optional, leave empty to keep all versions) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli extension-service delete --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli extension-service delete --id 12345678-1234-5678-90ab-cdef01234567 --versions 1.0,1.1 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-get-version.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-get-version.md new file mode 100644 index 0000000000..fc06850445 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-get-version.md @@ -0,0 +1,57 @@ +# `nico-admin-cli extension-service get-version` + +_[Tenant commands](../../tenant.md) › [extension-service](./extension-service.md) › **get-version**_ + +## NAME + +nico-admin-cli-extension-service-get-version - Get extension service +version information + +## SYNOPSIS + +**nico-admin-cli extension-service get-version** +\<**-i**\|**--service-id**\> \[**-v**\|**--versions**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get extension service version information + +## OPTIONS + +**-i**, **--service-id** *\* +The extension service ID + +**-v**, **--versions** *\* +Version strings to get (optional, leave empty to get all versions) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli extension-service get-version --service-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli extension-service get-version --service-id 12345678-1234-5678-90ab-cdef01234567 --versions 1.0,1.1 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-show-instances.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-show-instances.md new file mode 100644 index 0000000000..e65acba6eb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-show-instances.md @@ -0,0 +1,57 @@ +# `nico-admin-cli extension-service show-instances` + +_[Tenant commands](../../tenant.md) › [extension-service](./extension-service.md) › **show-instances**_ + +## NAME + +nico-admin-cli-extension-service-show-instances - Show instances using +an extension service + +## SYNOPSIS + +**nico-admin-cli extension-service show-instances** +\<**-i**\|**--service-id**\> \[**-v**\|**--version**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show instances using an extension service + +## OPTIONS + +**-i**, **--service-id** *\* +The extension service ID + +**-v**, **--version** *\* +Version string to filter by (optional) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli extension-service show-instances --service-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli extension-service show-instances --service-id 12345678-1234-5678-90ab-cdef01234567 --version 1.0 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-show.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-show.md new file mode 100644 index 0000000000..4ba3c84699 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-show.md @@ -0,0 +1,72 @@ +# `nico-admin-cli extension-service show` + +_[Tenant commands](../../tenant.md) › [extension-service](./extension-service.md) › **show**_ + +## NAME + +nico-admin-cli-extension-service-show - Show extension service +information + +## SYNOPSIS + +**nico-admin-cli extension-service show** \[**-i**\|**--id**\] +\[**-t**\|**--type**\] \[**-n**\|**--name**\] +\[**-o**\|**--tenant-organization-id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show extension service information + +## OPTIONS + +**-i**, **--id** *\* +The extension service ID to show (leave empty to show all) + +**-t**, **--type** *\* +Filter by service type (optional)\ + +\ +*Possible values:* + +- kubernetes-pod + +**-n**, **--name** *\* +Filter by service name (optional) + +**-o**, **--tenant-organization-id** *\* +Filter by tenant organization ID (optional) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli extension-service show +nico-admin-cli extension-service show --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli extension-service show --type kubernetes-pod +nico-admin-cli extension-service show --name my-service +nico-admin-cli extension-service show --tenant-organization-id fds34511233a +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-update.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-update.md new file mode 100644 index 0000000000..41c758416f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service-update.md @@ -0,0 +1,83 @@ +# `nico-admin-cli extension-service update` + +_[Tenant commands](../../tenant.md) › [extension-service](./extension-service.md) › **update**_ + +## NAME + +nico-admin-cli-extension-service-update - Update an extension service + +## SYNOPSIS + +**nico-admin-cli extension-service update** \<**-i**\|**--id**\> +\[**-n**\|**--name**\] \[**--description**\] \<**-d**\|**--data**\> +\[**--registry-url**\] \[**-u**\|**--username**\] +\[**-p**\|**--password**\] \[**--if-version-ctr-match**\] +\[**--observability**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update an extension service + +## OPTIONS + +**-i**, **--id** *\* +The extension service ID to update + +**-n**, **--name** *\* +New extension service name (optional) + +**--description** *\* +New extension service description (optional) + +**-d**, **--data** *\* +New extension service data + +**--registry-url** *\* +New registry URL for the service credential (optional) + +**-u**, **--username** *\* +New username for the service credential (optional) + +**-p**, **--password** *\* +New password for the service credential (optional) + +**--if-version-ctr-match** *\* +Update only if current number of versions matches this number (optional) + +**--observability** *\* +JSON array containing a defined set of extension observability configs +(optional) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 --data '{"image":"my-registry/my-service:2.0"}' +nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 --name my-renamed-service --description "Updated telemetry agent" --data '{"image":"my-registry/my-service:2.0"}' +nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 --data '{"image":"my-registry/my-service:2.0"}' --registry-url my-registry.example.com --username admin --password mynewpassword +nico-admin-cli extension-service update --id 12345678-1234-5678-90ab-cdef01234567 --data '{"image":"my-registry/my-service:2.0"}' --if-version-ctr-match 3 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/extension-service/extension-service.md b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service.md new file mode 100644 index 0000000000..cc567f6f86 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/extension-service/extension-service.md @@ -0,0 +1,53 @@ +# `nico-admin-cli extension-service` + +_[Tenant commands](../../tenant.md) › **extension-service**_ + +## NAME + +nico-admin-cli-extension-service - Extension service management + +## SYNOPSIS + +**nico-admin-cli extension-service** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Extension service management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./extension-service-create.md) | Create an extension service | +| [`update`](./extension-service-update.md) | Update an extension service | +| [`delete`](./extension-service-delete.md) | Delete an extension service | +| [`show`](./extension-service-show.md) | Show extension service information | +| [`get-version`](./extension-service-get-version.md) | Get extension service version information | +| [`show-instances`](./extension-service-show-instances.md) | Show instances using an extension service | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/firmware/firmware-show.md b/docs/manuals/nico-admin-cli/commands/firmware/firmware-show.md new file mode 100644 index 0000000000..8043c84bf3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/firmware/firmware-show.md @@ -0,0 +1,48 @@ +# `nico-admin-cli firmware show` + +_[Hardware commands](../../hardware.md) › [firmware](./firmware.md) › **show**_ + +## NAME + +nico-admin-cli-firmware-show - Show available firmware + +## SYNOPSIS + +**nico-admin-cli firmware show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Show available firmware + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli firmware show +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/firmware/firmware.md b/docs/manuals/nico-admin-cli/commands/firmware/firmware.md new file mode 100644 index 0000000000..d4e67a3cdb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/firmware/firmware.md @@ -0,0 +1,48 @@ +# `nico-admin-cli firmware` + +_[Hardware commands](../../hardware.md) › **firmware**_ + +## NAME + +nico-admin-cli-firmware - Firmware related actions + +## SYNOPSIS + +**nico-admin-cli firmware** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Firmware related actions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./firmware-show.md) | Show available firmware | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-bash.md b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-bash.md new file mode 100644 index 0000000000..7942788f07 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-bash.md @@ -0,0 +1,40 @@ +# `nico-admin-cli generate-shell-complete bash` + +_[Admin commands](../../admin.md) › [generate-shell-complete](./generate-shell-complete.md) › **bash**_ + +## NAME + +nico-admin-cli-generate-shell-complete-bash + +## SYNOPSIS + +**nico-admin-cli generate-shell-complete bash** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-fish.md b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-fish.md new file mode 100644 index 0000000000..5892a4366e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-fish.md @@ -0,0 +1,40 @@ +# `nico-admin-cli generate-shell-complete fish` + +_[Admin commands](../../admin.md) › [generate-shell-complete](./generate-shell-complete.md) › **fish**_ + +## NAME + +nico-admin-cli-generate-shell-complete-fish + +## SYNOPSIS + +**nico-admin-cli generate-shell-complete fish** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-zsh.md b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-zsh.md new file mode 100644 index 0000000000..4863f4d9f0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete-zsh.md @@ -0,0 +1,40 @@ +# `nico-admin-cli generate-shell-complete zsh` + +_[Admin commands](../../admin.md) › [generate-shell-complete](./generate-shell-complete.md) › **zsh**_ + +## NAME + +nico-admin-cli-generate-shell-complete-zsh + +## SYNOPSIS + +**nico-admin-cli generate-shell-complete zsh** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete.md b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete.md new file mode 100644 index 0000000000..fb8fef8f30 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/generate-shell-complete/generate-shell-complete.md @@ -0,0 +1,62 @@ +# `nico-admin-cli generate-shell-complete` + +_[Admin commands](../../admin.md) › **generate-shell-complete**_ + +## NAME + +nico-admin-cli-generate-shell-complete - Generate shell autocomplete. +Source the output of this command: \`source \<(nico-admin-cli +generate-shell-complete bash)\` + +## SYNOPSIS + +**nico-admin-cli generate-shell-complete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Generate shell autocomplete. Source the output of this command: \`source +\<(nico-admin-cli generate-shell-complete bash)\` + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +source <(nico-admin-cli generate-shell-complete bash) +source <(nico-admin-cli generate-shell-complete zsh) +nico-admin-cli generate-shell-complete zsh > ~/.zfunc/_nico-admin-cli && echo 'compdef _nico-admin-cli carbide-admin-cli forge-admin-cli' >> ~/.zshrc +nico-admin-cli generate-shell-complete fish > ~/.config/fish/completions/nico-admin-cli.fish +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`bash`](./generate-shell-complete-bash.md) | | +| [`fish`](./generate-shell-complete-fish.md) | | +| [`zsh`](./generate-shell-complete-zsh.md) | | + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-clear-uefi-password.md b/docs/manuals/nico-admin-cli/commands/host/host-clear-uefi-password.md new file mode 100644 index 0000000000..652227dd28 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-clear-uefi-password.md @@ -0,0 +1,52 @@ +# `nico-admin-cli host clear-uefi-password` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › **clear-uefi-password**_ + +## NAME + +nico-admin-cli-host-clear-uefi-password - Clear Host UEFI password + +## SYNOPSIS + +**nico-admin-cli host clear-uefi-password** \<**-q**\|**--query**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Clear Host UEFI password + +## OPTIONS + +**-q**, **--query** *\* +ID, IPv4, MAC or hostnmame of the machine to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host clear-uefi-password --query 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli host clear-uefi-password --query 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-generate-host-uefi-password.md b/docs/manuals/nico-admin-cli/commands/host/host-generate-host-uefi-password.md new file mode 100644 index 0000000000..f4ed800bb0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-generate-host-uefi-password.md @@ -0,0 +1,50 @@ +# `nico-admin-cli host generate-host-uefi-password` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › **generate-host-uefi-password**_ + +## NAME + +nico-admin-cli-host-generate-host-uefi-password - Generates a string +that can be a site-default host UEFI password in Vault + +## SYNOPSIS + +**nico-admin-cli host generate-host-uefi-password** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Generates a string that can be a site-default host UEFI password in +Vault + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host generate-host-uefi-password +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-reprovision-clear.md b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-clear.md new file mode 100644 index 0000000000..dfe5d34ab1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-clear.md @@ -0,0 +1,54 @@ +# `nico-admin-cli host reprovision clear` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › [reprovision](./host-reprovision.md) › **clear**_ + +## NAME + +nico-admin-cli-host-reprovision-clear - Clear the reprovisioning mode. + +## SYNOPSIS + +**nico-admin-cli host reprovision clear** \<**-i**\|**--id**\> +\[**-u**\|**--update-firmware**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Clear the reprovisioning mode. + +## OPTIONS + +**-i**, **--id** *\* +Machine ID for which reprovisioning should be cleared. + +**-u**, **--update-firmware** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 --update-firmware +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-reprovision-list.md b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-list.md new file mode 100644 index 0000000000..5fade499eb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-list.md @@ -0,0 +1,43 @@ +# `nico-admin-cli host reprovision list` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › [reprovision](./host-reprovision.md) › **list**_ + +## NAME + +nico-admin-cli-host-reprovision-list - List all hosts pending +reprovisioning. + +## SYNOPSIS + +**nico-admin-cli host reprovision list** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all hosts pending reprovisioning. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-reprovision-mark-manual-upgrade-complete.md b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-mark-manual-upgrade-complete.md new file mode 100644 index 0000000000..96be3438a9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-mark-manual-upgrade-complete.md @@ -0,0 +1,53 @@ +# `nico-admin-cli host reprovision mark-manual-upgrade-complete` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › [reprovision](./host-reprovision.md) › **mark-manual-upgrade-complete**_ + +## NAME + +nico-admin-cli-host-reprovision-mark-manual-upgrade-complete - Mark +manual firmware upgrade as complete for a host. + +## SYNOPSIS + +**nico-admin-cli host reprovision mark-manual-upgrade-complete** +\<**-i**\|**--id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Mark manual firmware upgrade as complete for a host. + +## OPTIONS + +**-i**, **--id** *\* +Machine ID for which manual firmware upgrade should be set. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host reprovision mark-manual-upgrade-complete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-reprovision-set.md b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-set.md new file mode 100644 index 0000000000..660e7f72e5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-reprovision-set.md @@ -0,0 +1,59 @@ +# `nico-admin-cli host reprovision set` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › [reprovision](./host-reprovision.md) › **set**_ + +## NAME + +nico-admin-cli-host-reprovision-set - Set the host in reprovisioning +mode. + +## SYNOPSIS + +**nico-admin-cli host reprovision set** \<**-i**\|**--id**\> +\[**-u**\|**--update-firmware**\] \[**--update-message**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set the host in reprovisioning mode. + +## OPTIONS + +**-i**, **--id** *\* +Machine ID for which reprovisioning is needed. + +**-u**, **--update-firmware** +**--update-message** *\* +If set, a HostUpdateInProgress health alert will be applied to the host + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 --update-firmware +nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 --update-message "Quarterly firmware refresh" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-reprovision.md b/docs/manuals/nico-admin-cli/commands/host/host-reprovision.md new file mode 100644 index 0000000000..3cf7fb44ba --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-reprovision.md @@ -0,0 +1,59 @@ +# `nico-admin-cli host reprovision` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › **reprovision**_ + +## NAME + +nico-admin-cli-host-reprovision - Host reprovisioning handling + +## SYNOPSIS + +**nico-admin-cli host reprovision** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Host reprovisioning handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host reprovision set --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli host reprovision clear --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli host reprovision list +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set`](./host-reprovision-set.md) | Set the host in reprovisioning mode. | +| [`clear`](./host-reprovision-clear.md) | Clear the reprovisioning mode. | +| [`list`](./host-reprovision-list.md) | List all hosts pending reprovisioning. | +| [`mark-manual-upgrade-complete`](./host-reprovision-mark-manual-upgrade-complete.md) | Mark manual firmware upgrade as complete for a host. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host-set-uefi-password.md b/docs/manuals/nico-admin-cli/commands/host/host-set-uefi-password.md new file mode 100644 index 0000000000..b76855feed --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host-set-uefi-password.md @@ -0,0 +1,52 @@ +# `nico-admin-cli host set-uefi-password` + +_[Hardware commands](../../hardware.md) › [host](./host.md) › **set-uefi-password**_ + +## NAME + +nico-admin-cli-host-set-uefi-password - Set Host UEFI password + +## SYNOPSIS + +**nico-admin-cli host set-uefi-password** \<**-q**\|**--query**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set Host UEFI password + +## OPTIONS + +**-q**, **--query** *\* +ID, IPv4, MAC or hostnmame of the machine to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli host set-uefi-password --query 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli host set-uefi-password --query 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/host/host.md b/docs/manuals/nico-admin-cli/commands/host/host.md new file mode 100644 index 0000000000..34b8ca808a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/host/host.md @@ -0,0 +1,51 @@ +# `nico-admin-cli host` + +_[Hardware commands](../../hardware.md) › **host**_ + +## NAME + +nico-admin-cli-host - Host specific handling + +## SYNOPSIS + +**nico-admin-cli host** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Host specific handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set-uefi-password`](./host-set-uefi-password.md) | Set Host UEFI password | +| [`clear-uefi-password`](./host-clear-uefi-password.md) | Clear Host UEFI password | +| [`generate-host-uefi-password`](./host-generate-host-uefi-password.md) | Generates a string that can be a site-default host UEFI password in Vault | +| [`reprovision`](./host-reprovision.md) | Host reprovisioning handling | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ib-partition/ib-partition-show.md b/docs/manuals/nico-admin-cli/commands/ib-partition/ib-partition-show.md new file mode 100644 index 0000000000..3da67e4716 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ib-partition/ib-partition-show.md @@ -0,0 +1,62 @@ +# `nico-admin-cli ib-partition show` + +_[Network commands](../../network.md) › [ib-partition](./ib-partition.md) › **show**_ + +## NAME + +nico-admin-cli-ib-partition-show - Display InfiniBand Partition +information + +## SYNOPSIS + +**nico-admin-cli ib-partition show** \[**-t**\|**--tenant-org-id**\] +\[**-n**\|**--name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display InfiniBand Partition information + +## OPTIONS + +**-t**, **--tenant-org-id** *\* +The Tenant Org ID to query + +**-n**, **--name** *\* +The InfiniBand Partition name to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +The InfiniBand Partition ID to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli ib-partition show +nico-admin-cli ib-partition show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli ib-partition show --tenant-org-id fds34511233a +nico-admin-cli ib-partition show --name my-partition +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ib-partition/ib-partition.md b/docs/manuals/nico-admin-cli/commands/ib-partition/ib-partition.md new file mode 100644 index 0000000000..25813641b3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ib-partition/ib-partition.md @@ -0,0 +1,48 @@ +# `nico-admin-cli ib-partition` + +_[Network commands](../../network.md) › **ib-partition**_ + +## NAME + +nico-admin-cli-ib-partition - InfiniBand Partition related handling + +## SYNOPSIS + +**nico-admin-cli ib-partition** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +InfiniBand Partition related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./ib-partition-show.md) | Display InfiniBand Partition information | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-associate.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-associate.md new file mode 100644 index 0000000000..646b7bd7a3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-associate.md @@ -0,0 +1,57 @@ +# `nico-admin-cli instance-type associate` + +_[Tenant commands](../../tenant.md) › [instance-type](./instance-type.md) › **associate**_ + +## NAME + +nico-admin-cli-instance-type-associate - Associate an instance type with +machines + +## SYNOPSIS + +**nico-admin-cli instance-type associate** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INSTANCE_TYPE_ID*\> +\[*MACHINE_IDS*\] + +## DESCRIPTION + +Associate an instance type with machines + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INSTANCE_TYPE_ID*\> +InstanceTypeId + +\[*MACHINE_IDS*\] +Machine Ids, separated by comma + +## Examples + +```sh +nico-admin-cli instance-type associate 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli instance-type associate 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789,11111111-2222-3333-4444-555555555555 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-create.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-create.md new file mode 100644 index 0000000000..3af6ca9fd2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-create.md @@ -0,0 +1,69 @@ +# `nico-admin-cli instance-type create` + +_[Tenant commands](../../tenant.md) › [instance-type](./instance-type.md) › **create**_ + +## NAME + +nico-admin-cli-instance-type-create - Create an instance type + +## SYNOPSIS + +**nico-admin-cli instance-type create** \[**-i**\|**--id**\] +\[**-n**\|**--name**\] \[**-d**\|**--description**\] +\[**-l**\|**--labels**\] \[**-f**\|**--desired-capabilities**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create an instance type + +## OPTIONS + +**-i**, **--id** *\* +Optional, unique ID to use when creating the instance type + +**-n**, **--name** *\* +Name of the instance type + +**-d**, **--description** *\* +Description of the instance type + +**-l**, **--labels** *\* +JSON map of simple key:value pairs to be applied as labels to the +instance type + +**-f**, **--desired-capabilities** *\* +Optional, JSON array containing a set of instance type capability +filters + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance-type create --name dgx-h100 --description "DGX H100 640GB" +nico-admin-cli instance-type create --name dgx-h100 --labels '{"tier":"premium"}' --desired-capabilities '[{"key":"gpu_count","value":"8"}]' +nico-admin-cli instance-type create --id 12345678-1234-5678-90ab-cdef01234567 --name dgx-h100 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-delete.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-delete.md new file mode 100644 index 0000000000..6dee65ea24 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli instance-type delete` + +_[Tenant commands](../../tenant.md) › [instance-type](./instance-type.md) › **delete**_ + +## NAME + +nico-admin-cli-instance-type-delete - Delete an instance type + +## SYNOPSIS + +**nico-admin-cli instance-type delete** \<**-i**\|**--id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete an instance type + +## OPTIONS + +**-i**, **--id** *\* +Instance type ID to delete + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance-type delete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-disassociate.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-disassociate.md new file mode 100644 index 0000000000..fd0ef4f570 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-disassociate.md @@ -0,0 +1,52 @@ +# `nico-admin-cli instance-type disassociate` + +_[Tenant commands](../../tenant.md) › [instance-type](./instance-type.md) › **disassociate**_ + +## NAME + +nico-admin-cli-instance-type-disassociate - Remove an instance type +association from a machines + +## SYNOPSIS + +**nico-admin-cli instance-type disassociate** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Remove an instance type association from a machines + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine Id + +## Examples + +```sh +nico-admin-cli instance-type disassociate 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-show.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-show.md new file mode 100644 index 0000000000..f4882ec429 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-show.md @@ -0,0 +1,64 @@ +# `nico-admin-cli instance-type show` + +_[Tenant commands](../../tenant.md) › [instance-type](./instance-type.md) › **show**_ + +## NAME + +nico-admin-cli-instance-type-show - Show one or more instance types + +## SYNOPSIS + +**nico-admin-cli instance-type show** \[**-i**\|**--id**\] +\[**-s**\|**--show-stats**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Show one or more instance types + +## OPTIONS + +**-i**, **--id** *\* +Optional, instance type ID to restrict the search + +**-s**, **--show-stats** *\* +Optional, show counts for allocations of instance types\ + +\ +*Possible values:* + +- true + +- false + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance-type show +nico-admin-cli instance-type show --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance-type show --show-stats true +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-update.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-update.md new file mode 100644 index 0000000000..ddc9becc07 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type-update.md @@ -0,0 +1,75 @@ +# `nico-admin-cli instance-type update` + +_[Tenant commands](../../tenant.md) › [instance-type](./instance-type.md) › **update**_ + +## NAME + +nico-admin-cli-instance-type-update - Update an instance type + +## SYNOPSIS + +**nico-admin-cli instance-type update** \<**-i**\|**--id**\> +\[**-n**\|**--name**\] \[**-d**\|**--description**\] +\[**-l**\|**--labels**\] \[**-f**\|**--desired-capabilities**\] +\[**-v**\|**--version**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update an instance type + +## OPTIONS + +**-i**, **--id** *\* +Instance type ID to update + +**-n**, **--name** *\* +Name of the instance type + +**-d**, **--description** *\* +Description of the instance type + +**-l**, **--labels** *\* +JSON map of simple key:value pairs to be applied as labels to the +instance type - will COMPLETELY overwrite any existing labels + +**-f**, **--desired-capabilities** *\* +Optional, JSON array containing a set of instance type capability +filters - will COMPLETELY overwrite any existing filters + +**-v**, **--version** *\* +Optional, version to use for comparison when performing the update, +which will be rejected if the actual version of the record does not +match the value of this parameter + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 --name dgx-h100-640gb +nico-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 --labels '{"tier":"premium"}' --desired-capabilities '[{"key":"gpu_count","value":"8"}]' +nico-admin-cli instance-type update --id 12345678-1234-5678-90ab-cdef01234567 --description "DGX H100 640GB" --version 3 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance-type/instance-type.md b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type.md new file mode 100644 index 0000000000..74cceb2043 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance-type/instance-type.md @@ -0,0 +1,53 @@ +# `nico-admin-cli instance-type` + +_[Tenant commands](../../tenant.md) › **instance-type**_ + +## NAME + +nico-admin-cli-instance-type - Instance type management + +## SYNOPSIS + +**nico-admin-cli instance-type** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Instance type management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./instance-type-create.md) | Create an instance type | +| [`show`](./instance-type-show.md) | Show one or more instance types | +| [`delete`](./instance-type-delete.md) | Delete an instance type | +| [`update`](./instance-type-update.md) | Update an instance type | +| [`associate`](./instance-type-associate.md) | Associate an instance type with machines | +| [`disassociate`](./instance-type-disassociate.md) | Remove an instance type association from a machines | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-allocate.md b/docs/manuals/nico-admin-cli/commands/instance/instance-allocate.md new file mode 100644 index 0000000000..be62b53dda --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-allocate.md @@ -0,0 +1,124 @@ +# `nico-admin-cli instance allocate` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **allocate**_ + +## NAME + +nico-admin-cli-instance-allocate - Allocate instance + +## SYNOPSIS + +**nico-admin-cli instance allocate** \[**-n**\|**--number**\] +\[**-s**\|**--subnet**\] \[**-t**\|**--tenant-org**\] +\<**-p**\|**--prefix-name**\> \[**--label-key**\] \[**--label-value**\] +\[**--network-security-group-id**\] \[**--instance-type-id**\] +\[**--os**\] \[**--spxconfig**\] \[**--vf-subnet**\] +\[**-v**\|**--vpc-prefix-id**\] \[**--zero-dpu**\] \[**--extended**\] +\[**--vf-vpc-prefix-id**\] \[**--ip-address**\] \[**--vf-ip-address**\] +\[**--ipv6-vpc-prefix-id**\] \[**--ipv6-vf-prefix-id**\] +\[**--ipv6-ip-address**\] \[**--ipv6-vf-ip-address**\] +\[**--machine-id**\] \[**--transactional**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Allocate instance + +## OPTIONS + +**-n**, **--number** *\* +**-s**, **--subnet** *\* +The subnet to assign to a PF + +**-t**, **--tenant-org** *\* +**-p**, **--prefix-name** *\* +**--label-key** *\* +The key of label instance to query + +**--label-value** *\* +The value of label instance to query + +**--network-security-group-id** *\* +The ID of a network security group to apply to the new instance upon +creation + +**--instance-type-id** *\* +The expected instance type id for the instance, which will be compared +to type ID set for the machine of the request + +**--os** *\* +OS definition in JSON format + +**--spxconfig** *\* +SPX configuration in JSON format + +**--vf-subnet** *\* +The subnet to assign to a VF + +**-v**, **--vpc-prefix-id** *\* +The VPC prefix to assign to a PF + +**--zero-dpu** +Allocate a zero-dpu host + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--vf-vpc-prefix-id** *\* +The VPC prefix to assign to a VF + +**--ip-address** *\* +Explicit IPv4 address to request for each PF interface + +**--vf-ip-address** *\* +Explicit IPv4 address to request for each VF interface + +**--ipv6-vpc-prefix-id** *\* +IPv6 VPC prefix to pair with each PF vpc-prefix-id for dual-stack + +**--ipv6-vf-prefix-id** *\* +IPv6 VPC prefix to pair with each VF vf-vpc-prefix-id for dual-stack + +**--ipv6-ip-address** *\* +Explicit IPv6 address to request for each PF interface (dual-stack) + +**--ipv6-vf-ip-address** *\* +Explicit IPv6 address to request for each VF interface (dual-stack) + +**--machine-id** *\* +The machine ids for the machines to use (instead of searching) + +**--transactional** +Use batch API for all-or-nothing allocation (requires --number \> 1) + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance allocate --prefix-name eth0 --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance allocate --prefix-name eth0 --subnet 192.0.2.0/24 +nico-admin-cli instance allocate --number 4 --prefix-name eth0 --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance allocate --number 4 --prefix-name eth0 --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 --transactional +nico-admin-cli instance allocate --prefix-name eth0 --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 --machine-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance allocate --prefix-name eth0 --vpc-prefix-id 12345678-1234-5678-90ab-cdef01234567 --instance-type-id abcdef01-2345-6789-abcd-ef0123456789 --network-security-group-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-reboot.md b/docs/manuals/nico-admin-cli/commands/instance/instance-reboot.md new file mode 100644 index 0000000000..9fa58136f1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-reboot.md @@ -0,0 +1,55 @@ +# `nico-admin-cli instance reboot` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **reboot**_ + +## NAME + +nico-admin-cli-instance-reboot - Reboot instance, potentially applying +firmware updates + +## SYNOPSIS + +**nico-admin-cli instance reboot** \<**-i**\|**--instance**\> +\[**-c**\|**--custom-pxe**\] \[**-a**\|**--apply-updates-on-reboot**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Reboot instance, potentially applying firmware updates + +## OPTIONS + +**-i**, **--instance** *\* +**-c**, **--custom-pxe** +**-a**, **--apply-updates-on-reboot** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 --apply-updates-on-reboot +nico-admin-cli instance reboot --instance 12345678-1234-5678-90ab-cdef01234567 --custom-pxe +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-release.md b/docs/manuals/nico-admin-cli/commands/instance/instance-release.md new file mode 100644 index 0000000000..aec183e814 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-release.md @@ -0,0 +1,59 @@ +# `nico-admin-cli instance release` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **release**_ + +## NAME + +nico-admin-cli-instance-release - De-allocate instance + +## SYNOPSIS + +**nico-admin-cli instance release** \[**-i**\|**--instance**\] +\[**-m**\|**--machine**\] \[**--label-key**\] \[**--label-value**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +De-allocate instance + +## OPTIONS + +**-i**, **--instance** *\* +**-m**, **--machine** *\* +**--label-key** *\* +The key of label instance to query + +**--label-value** *\* +The value of label instance to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance release --instance 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance release --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance release --label-key role --label-value training +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-show.md b/docs/manuals/nico-admin-cli/commands/instance/instance-show.md new file mode 100644 index 0000000000..76e5f4b2aa --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-show.md @@ -0,0 +1,74 @@ +# `nico-admin-cli instance show` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **show**_ + +## NAME + +nico-admin-cli-instance-show - Display instance information + +## SYNOPSIS + +**nico-admin-cli instance show** \[**-e**\|**--extrainfo**\] +\[**-t**\|**--tenant-org-id**\] \[**-v**\|**--vpc-id**\] +\[**--label-key**\] \[**--label-value**\] \[**--instance-type-id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display instance information + +## OPTIONS + +**-e**, **--extrainfo** +**-t**, **--tenant-org-id** *\* +The Tenant Org ID to query + +**-v**, **--vpc-id** *\* +The VPC ID to query. + +**--label-key** *\* +The key of label instance to query + +**--label-value** *\* +The value of label instance to query + +**--instance-type-id** *\* +The instance type ID to query. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] \[default: \] +The instance ID to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli instance show +nico-admin-cli instance show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli instance show --tenant-org-id fds34511233a +nico-admin-cli instance show --vpc-id abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli instance show --label-key role --label-value training +nico-admin-cli instance show --instance-type-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-update-ib-config.md b/docs/manuals/nico-admin-cli/commands/instance/instance-update-ib-config.md new file mode 100644 index 0000000000..e2bd418530 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-update-ib-config.md @@ -0,0 +1,54 @@ +# `nico-admin-cli instance update-ib-config` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **update-ib-config**_ + +## NAME + +nico-admin-cli-instance-update-ib-config - Update instance IB +configuration + +## SYNOPSIS + +**nico-admin-cli instance update-ib-config** \<**-i**\|**--instance**\> +\<**--config**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update instance IB configuration + +## OPTIONS + +**-i**, **--instance** *\* +**--config** *\* +IB configuration in JSON format + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance update-ib-config --instance 12345678-1234-5678-90ab-cdef01234567 --config '{"partitions":[]}' +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-update-nv-link-config.md b/docs/manuals/nico-admin-cli/commands/instance/instance-update-nv-link-config.md new file mode 100644 index 0000000000..70dfcd12ad --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-update-nv-link-config.md @@ -0,0 +1,54 @@ +# `nico-admin-cli instance update-nv-link-config` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **update-nv-link-config**_ + +## NAME + +nico-admin-cli-instance-update-nv-link-config - Update instance NVLink +configuration + +## SYNOPSIS + +**nico-admin-cli instance update-nv-link-config** +\<**-i**\|**--instance**\> \<**--config**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Update instance NVLink configuration + +## OPTIONS + +**-i**, **--instance** *\* +**--config** *\* +NVLink configuration in JSON format + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance update-nv-link-config --instance 12345678-1234-5678-90ab-cdef01234567 --config '{"partition_id":"abcdef01-2345-6789-abcd-ef0123456789"}' +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-update-os.md b/docs/manuals/nico-admin-cli/commands/instance/instance-update-os.md new file mode 100644 index 0000000000..94ae90dd60 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-update-os.md @@ -0,0 +1,52 @@ +# `nico-admin-cli instance update-os` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **update-os**_ + +## NAME + +nico-admin-cli-instance-update-os - Update instance OS + +## SYNOPSIS + +**nico-admin-cli instance update-os** \<**-i**\|**--instance**\> +\<**--os**\> \[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Update instance OS + +## OPTIONS + +**-i**, **--instance** *\* +**--os** *\* +OS definition in JSON format + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance update-os --instance 12345678-1234-5678-90ab-cdef01234567 --os '{"os_image_id":"abcdef01-2345-6789-abcd-ef0123456789"}' +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance-update-spx-config.md b/docs/manuals/nico-admin-cli/commands/instance/instance-update-spx-config.md new file mode 100644 index 0000000000..e6b4b438c6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance-update-spx-config.md @@ -0,0 +1,54 @@ +# `nico-admin-cli instance update-spx-config` + +_[Tenant commands](../../tenant.md) › [instance](./instance.md) › **update-spx-config**_ + +## NAME + +nico-admin-cli-instance-update-spx-config - Update instance SPX +configuration + +## SYNOPSIS + +**nico-admin-cli instance update-spx-config** \<**-i**\|**--instance**\> +\<**--config**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update instance SPX configuration + +## OPTIONS + +**-i**, **--instance** *\* +**--config** *\* +SPX configuration in JSON format + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli instance update-spx-config --instance 12345678-1234-5678-90ab-cdef01234567 --config '{"partition_id":"abcdef01-2345-6789-abcd-ef0123456789"}' +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/instance/instance.md b/docs/manuals/nico-admin-cli/commands/instance/instance.md new file mode 100644 index 0000000000..9ec07f4ad6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/instance/instance.md @@ -0,0 +1,55 @@ +# `nico-admin-cli instance` + +_[Tenant commands](../../tenant.md) › **instance**_ + +## NAME + +nico-admin-cli-instance - Instance related handling + +## SYNOPSIS + +**nico-admin-cli instance** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Instance related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./instance-show.md) | Display instance information | +| [`reboot`](./instance-reboot.md) | Reboot instance, potentially applying firmware updates | +| [`release`](./instance-release.md) | De-allocate instance | +| [`allocate`](./instance-allocate.md) | Allocate instance | +| [`update-os`](./instance-update-os.md) | Update instance OS | +| [`update-ib-config`](./instance-update-ib-config.md) | Update instance IB configuration | +| [`update-nv-link-config`](./instance-update-nv-link-config.md) | Update instance NVLink configuration | +| [`update-spx-config`](./instance-update-spx-config.md) | Update instance SPX configuration | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/inventory/inventory.md b/docs/manuals/nico-admin-cli/commands/inventory/inventory.md new file mode 100644 index 0000000000..2b2763e2eb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/inventory/inventory.md @@ -0,0 +1,52 @@ +# `nico-admin-cli inventory` + +_[Hardware commands](../../hardware.md) › **inventory**_ + +## NAME + +nico-admin-cli-inventory - Generate Ansible Inventory + +## SYNOPSIS + +**nico-admin-cli inventory** \[**-f**\|**--filename**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Generate Ansible Inventory + +## OPTIONS + +**-f**, **--filename** *\* +Write to file + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli inventory +nico-admin-cli inventory --filename ./inventory.ini +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ip/ip-find.md b/docs/manuals/nico-admin-cli/commands/ip/ip-find.md new file mode 100644 index 0000000000..007aa00d09 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ip/ip-find.md @@ -0,0 +1,50 @@ +# `nico-admin-cli ip find` + +_[Network commands](../../network.md) › [ip](./ip.md) › **find**_ + +## NAME + +nico-admin-cli-ip-find + +## SYNOPSIS + +**nico-admin-cli ip find** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IP*\> + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IP*\> +The IP address we are looking to identify + +## Examples + +```sh +nico-admin-cli ip find 192.0.2.10 +nico-admin-cli ip find 2001:db8::1 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ip/ip.md b/docs/manuals/nico-admin-cli/commands/ip/ip.md new file mode 100644 index 0000000000..c7327a81e2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ip/ip.md @@ -0,0 +1,48 @@ +# `nico-admin-cli ip` + +_[Network commands](../../network.md) › **ip**_ + +## NAME + +nico-admin-cli-ip - IP address handling + +## SYNOPSIS + +**nico-admin-cli ip** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +IP address handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`find`](./ip-find.md) | | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ipxe-template/ipxe-template-show.md b/docs/manuals/nico-admin-cli/commands/ipxe-template/ipxe-template-show.md new file mode 100644 index 0000000000..76149f2f71 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ipxe-template/ipxe-template-show.md @@ -0,0 +1,53 @@ +# `nico-admin-cli ipxe-template show` + +_[Tenant commands](../../tenant.md) › [ipxe-template](./ipxe-template.md) › **show**_ + +## NAME + +nico-admin-cli-ipxe-template-show - Show iPXE templates (all, or one by +name). + +## SYNOPSIS + +**nico-admin-cli ipxe-template show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Show iPXE templates (all, or one by name). + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +Template ID (UUID); omit to list all. + +## Examples + +```sh +nico-admin-cli ipxe-template show +nico-admin-cli ipxe-template show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ipxe-template/ipxe-template.md b/docs/manuals/nico-admin-cli/commands/ipxe-template/ipxe-template.md new file mode 100644 index 0000000000..03f503c2d6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ipxe-template/ipxe-template.md @@ -0,0 +1,48 @@ +# `nico-admin-cli ipxe-template` + +_[Tenant commands](../../tenant.md) › **ipxe-template**_ + +## NAME + +nico-admin-cli-ipxe-template - iPXE template management + +## SYNOPSIS + +**nico-admin-cli ipxe-template** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +iPXE template management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./ipxe-template-show.md) | Show iPXE templates (all, or one by name). | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/jump/jump.md b/docs/manuals/nico-admin-cli/commands/jump/jump.md new file mode 100644 index 0000000000..52f41ade0d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/jump/jump.md @@ -0,0 +1,53 @@ +# `nico-admin-cli jump` + +_[Admin commands](../../admin.md) › **jump**_ + +## NAME + +nico-admin-cli-jump - Broad search across multiple object types + +## SYNOPSIS + +**nico-admin-cli jump** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*ID*\> + +## DESCRIPTION + +Broad search across multiple object types + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +The machine ID, IP, UUID, etc, to find + +## Examples + +```sh +nico-admin-cli jump 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli jump 192.0.2.10 +nico-admin-cli jump 00:11:22:33:44:55 +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-create.md b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-create.md new file mode 100644 index 0000000000..3a400c940d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-create.md @@ -0,0 +1,55 @@ +# `nico-admin-cli logical-partition create` + +_[Network commands](../../network.md) › [logical-partition](./logical-partition.md) › **create**_ + +## NAME + +nico-admin-cli-logical-partition-create - Create logical partition + +## SYNOPSIS + +**nico-admin-cli logical-partition create** \<**-n**\|**--name**\> +\<**-t**\|**--tenant-organization-id**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create logical partition + +## OPTIONS + +**-n**, **--name** *\* +name of the partition + +**-t**, **--tenant-organization-id** *\* +tenant organization id of the partition + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli logical-partition create --name my-partition --tenant-organization-id fds34511233a +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-delete.md b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-delete.md new file mode 100644 index 0000000000..7754f07dc8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli logical-partition delete` + +_[Network commands](../../network.md) › [logical-partition](./logical-partition.md) › **delete**_ + +## NAME + +nico-admin-cli-logical-partition-delete - Delete logical partition + +## SYNOPSIS + +**nico-admin-cli logical-partition delete** \<**-n**\|**--name**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete logical partition + +## OPTIONS + +**-n**, **--name** *\* +name of the partition + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli logical-partition delete --name my-partition +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-show.md b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-show.md new file mode 100644 index 0000000000..e2ae759dc3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition-show.md @@ -0,0 +1,57 @@ +# `nico-admin-cli logical-partition show` + +_[Network commands](../../network.md) › [logical-partition](./logical-partition.md) › **show**_ + +## NAME + +nico-admin-cli-logical-partition-show - Display logical partition +information + +## SYNOPSIS + +**nico-admin-cli logical-partition show** \[**-n**\|**--name**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display logical partition information + +## OPTIONS + +**-n**, **--name** *\* +Optional, Logical Partition Name to search for + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] \[default: \] +Optional, Logical Partition ID to search for + +## Examples + +```sh +nico-admin-cli logical-partition show +nico-admin-cli logical-partition show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli logical-partition show --name my-partition +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition.md b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition.md new file mode 100644 index 0000000000..a41cd9aeec --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/logical-partition/logical-partition.md @@ -0,0 +1,50 @@ +# `nico-admin-cli logical-partition` + +_[Network commands](../../network.md) › **logical-partition**_ + +## NAME + +nico-admin-cli-logical-partition - Logical partition related handling + +## SYNOPSIS + +**nico-admin-cli logical-partition** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Logical partition related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./logical-partition-show.md) | Display logical partition information | +| [`create`](./logical-partition-create.md) | Create logical partition | +| [`delete`](./logical-partition-delete.md) | Delete logical partition | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-assign-address.md b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-assign-address.md new file mode 100644 index 0000000000..70358cd6c5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-assign-address.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine-interfaces assign-address` + +_[Hardware commands](../../hardware.md) › [machine-interfaces](./machine-interfaces.md) › **assign-address**_ + +## NAME + +nico-admin-cli-machine-interfaces-assign-address - Assign a static +address to a machine interface + +## SYNOPSIS + +**nico-admin-cli machine-interfaces assign-address** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INTERFACE_ID*\> +\<*IP_ADDRESS*\> + +## DESCRIPTION + +Assign a static address to a machine interface + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> +The machine interface ID to assign the address to + +\<*IP_ADDRESS*\> +The IP address to assign (IPv4 or IPv6) + +## Examples + +```sh +nico-admin-cli machine-interfaces assign-address 12345678-1234-5678-90ab-cdef01234567 192.0.2.20 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-delete.md b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-delete.md new file mode 100644 index 0000000000..f5b2eeeae8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-delete.md @@ -0,0 +1,52 @@ +# `nico-admin-cli machine-interfaces delete` + +_[Hardware commands](../../hardware.md) › [machine-interfaces](./machine-interfaces.md) › **delete**_ + +## NAME + +nico-admin-cli-machine-interfaces-delete - Delete Machine interface. + +## SYNOPSIS + +**nico-admin-cli machine-interfaces delete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INTERFACE_ID*\> + +## DESCRIPTION + +Delete Machine interface. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> +The interface ID to delete. Redeploy kea after deleting machine +interfaces. + +## Examples + +```sh +nico-admin-cli machine-interfaces delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-remove-address.md b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-remove-address.md new file mode 100644 index 0000000000..77435e2c96 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-remove-address.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine-interfaces remove-address` + +_[Hardware commands](../../hardware.md) › [machine-interfaces](./machine-interfaces.md) › **remove-address**_ + +## NAME + +nico-admin-cli-machine-interfaces-remove-address - Remove a static +address from a machine interface + +## SYNOPSIS + +**nico-admin-cli machine-interfaces remove-address** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INTERFACE_ID*\> +\<*IP_ADDRESS*\> + +## DESCRIPTION + +Remove a static address from a machine interface + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> +The machine interface ID to remove the address from + +\<*IP_ADDRESS*\> +The IP address to remove + +## Examples + +```sh +nico-admin-cli machine-interfaces remove-address 12345678-1234-5678-90ab-cdef01234567 10.0.0.5 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-show-addresses.md b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-show-addresses.md new file mode 100644 index 0000000000..660258d1d6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-show-addresses.md @@ -0,0 +1,52 @@ +# `nico-admin-cli machine-interfaces show-addresses` + +_[Hardware commands](../../hardware.md) › [machine-interfaces](./machine-interfaces.md) › **show-addresses**_ + +## NAME + +nico-admin-cli-machine-interfaces-show-addresses - Show addresses for a +machine interface + +## SYNOPSIS + +**nico-admin-cli machine-interfaces show-addresses** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*INTERFACE_ID*\> + +## DESCRIPTION + +Show addresses for a machine interface + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*INTERFACE_ID*\> +The machine interface ID to show addresses for + +## Examples + +```sh +nico-admin-cli machine-interfaces show-addresses 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-show.md b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-show.md new file mode 100644 index 0000000000..708b17966a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces-show.md @@ -0,0 +1,57 @@ +# `nico-admin-cli machine-interfaces show` + +_[Hardware commands](../../hardware.md) › [machine-interfaces](./machine-interfaces.md) › **show**_ + +## NAME + +nico-admin-cli-machine-interfaces-show - List of all Machine interfaces + +## SYNOPSIS + +**nico-admin-cli machine-interfaces show** \[**-a**\|**--all**\] +\[**--more**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*INTERFACE_ID*\] + +## DESCRIPTION + +List of all Machine interfaces + +## OPTIONS + +**-a**, **--all** +Show all machine interfaces (DEPRECATED) + +**--more** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*INTERFACE_ID*\] +The interface ID to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli machine-interfaces show +nico-admin-cli machine-interfaces show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces.md b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces.md new file mode 100644 index 0000000000..a660a668fb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-interfaces/machine-interfaces.md @@ -0,0 +1,53 @@ +# `nico-admin-cli machine-interfaces` + +_[Hardware commands](../../hardware.md) › **machine-interfaces**_ + +## NAME + +nico-admin-cli-machine-interfaces - Machine interfaces and address +management + +## SYNOPSIS + +**nico-admin-cli machine-interfaces** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Machine interfaces and address management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-interfaces-show.md) | List of all Machine interfaces | +| [`delete`](./machine-interfaces-delete.md) | Delete Machine interface. | +| [`show-addresses`](./machine-interfaces-show-addresses.md) | Show addresses for a machine interface | +| [`assign-address`](./machine-interfaces-assign-address.md) | Assign a static address to a machine interface | +| [`remove-address`](./machine-interfaces-remove-address.md) | Remove a static address from a machine interface | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-add-update.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-add-update.md new file mode 100644 index 0000000000..f4b20cd81b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-add-update.md @@ -0,0 +1,54 @@ +# `nico-admin-cli machine-validation external-config add-update` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [external-config](./machine-validation-external-config.md) › **add-update**_ + +## NAME + +nico-admin-cli-machine-validation-external-config-add-update - Update +External config + +## SYNOPSIS + +**nico-admin-cli machine-validation external-config add-update** +\<**-f**\|**--file-name**\> \<**-n**\|**--name**\> +\<**-d**\|**--description**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update External config + +## OPTIONS + +**-f**, **--file-name** *\* +Name of the file to update + +**-n**, **--name** *\* +Name of the config + +**-d**, **--description** *\* +description of the file to update + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-remove.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-remove.md new file mode 100644 index 0000000000..389bcfd710 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-remove.md @@ -0,0 +1,47 @@ +# `nico-admin-cli machine-validation external-config remove` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [external-config](./machine-validation-external-config.md) › **remove**_ + +## NAME + +nico-admin-cli-machine-validation-external-config-remove - Remove +External config + +## SYNOPSIS + +**nico-admin-cli machine-validation external-config remove** +\<**-n**\|**--name**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Remove External config + +## OPTIONS + +**-n**, **--name** *\* +Machine validation external config name + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-show.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-show.md new file mode 100644 index 0000000000..64e56f54e7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config-show.md @@ -0,0 +1,47 @@ +# `nico-admin-cli machine-validation external-config show` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [external-config](./machine-validation-external-config.md) › **show**_ + +## NAME + +nico-admin-cli-machine-validation-external-config-show - Show External +config + +## SYNOPSIS + +**nico-admin-cli machine-validation external-config show** +\[**-n**\|**--name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Show External config + +## OPTIONS + +**-n**, **--name** *\* +Machine validation external config names + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config.md new file mode 100644 index 0000000000..29e1af9233 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-external-config.md @@ -0,0 +1,58 @@ +# `nico-admin-cli machine-validation external-config` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › **external-config**_ + +## NAME + +nico-admin-cli-machine-validation-external-config - External config + +## SYNOPSIS + +**nico-admin-cli machine-validation external-config** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +External config + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine-validation external-config show --name my-config +nico-admin-cli machine-validation external-config add-update --name my-config --file-name ./config.toml --description "validation overrides" +nico-admin-cli machine-validation external-config remove --name my-config +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-validation-external-config-show.md) | Show External config | +| [`add-update`](./machine-validation-external-config-add-update.md) | Update External config | +| [`remove`](./machine-validation-external-config-remove.md) | Remove External config | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-on-demand-start.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-on-demand-start.md new file mode 100644 index 0000000000..33fe17d02b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-on-demand-start.md @@ -0,0 +1,58 @@ +# `nico-admin-cli machine-validation on-demand start` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [on-demand](./machine-validation-on-demand.md) › **start**_ + +## NAME + +nico-admin-cli-machine-validation-on-demand-start - Start on demand +machine validation + +## SYNOPSIS + +**nico-admin-cli machine-validation on-demand start** \[**--help**\] +\<**-m**\|**--machine**\> \[**--tags**\] \[**--allowed-tests**\] +\[**--run-unverified-tests**\] \[**--contexts**\] \[**--extended**\] +\[**--sort-by**\] + +## DESCRIPTION + +Start on demand machine validation + +## OPTIONS + +**--help** +**-m**, **--machine** *\* +Machine id for start validation + +**--tags** *\* +Results history + +**--allowed-tests** *\* +Allowed tests + +**--run-unverified-tests** +Run unverified tests + +**--contexts** *\* +Contexts + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-on-demand.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-on-demand.md new file mode 100644 index 0000000000..abbdfc8b07 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-on-demand.md @@ -0,0 +1,55 @@ +# `nico-admin-cli machine-validation on-demand` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › **on-demand**_ + +## NAME + +nico-admin-cli-machine-validation-on-demand - Ondemand Validation + +## SYNOPSIS + +**nico-admin-cli machine-validation on-demand** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Ondemand Validation + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine-validation on-demand start --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine-validation on-demand start --machine 12345678-1234-5678-90ab-cdef01234567 --allowed-tests gpu_bandwidth --run-unverified-tests +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`start`](./machine-validation-on-demand-start.md) | Start on demand machine validation | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-results-show.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-results-show.md new file mode 100644 index 0000000000..aad9f6764b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-results-show.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine-validation results show` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [results](./machine-validation-results.md) › **show**_ + +## NAME + +nico-admin-cli-machine-validation-results-show - Show results + +## SYNOPSIS + +**nico-admin-cli machine-validation results show** +\[**-m**\|**--machine**\] \[**-v**\|**--validation-id**\] +\[**-t**\|**--test-name**\] \[**--history**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show results + +## OPTIONS + +**-m**, **--machine** *\* +Show machine validation result of a machine + +**-v**, **--validation-id** *\* +Machine validation id + +**-t**, **--test-name** *\* +Name of the test case + +**--history** +Results history + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-results.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-results.md new file mode 100644 index 0000000000..87b55cd0ea --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-results.md @@ -0,0 +1,57 @@ +# `nico-admin-cli machine-validation results` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › **results**_ + +## NAME + +nico-admin-cli-machine-validation-results - Display machine validation +results of individual runs + +## SYNOPSIS + +**nico-admin-cli machine-validation results** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Display machine validation results of individual runs + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine-validation results show --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine-validation results show --validation-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine-validation results show --validation-id 12345678-1234-5678-90ab-cdef01234567 --test-name gpu_bandwidth --history +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-validation-results-show.md) | Show results | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-runs-show.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-runs-show.md new file mode 100644 index 0000000000..34c723be18 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-runs-show.md @@ -0,0 +1,49 @@ +# `nico-admin-cli machine-validation runs show` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [runs](./machine-validation-runs.md) › **show**_ + +## NAME + +nico-admin-cli-machine-validation-runs-show - Show Runs + +## SYNOPSIS + +**nico-admin-cli machine-validation runs show** +\[**-m**\|**--machine**\] \[**--history**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show Runs + +## OPTIONS + +**-m**, **--machine** *\* +Show machine validation runs of a machine + +**--history** +run history + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-runs.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-runs.md new file mode 100644 index 0000000000..84f6656249 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-runs.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine-validation runs` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › **runs**_ + +## NAME + +nico-admin-cli-machine-validation-runs - Display all machine validation +runs + +## SYNOPSIS + +**nico-admin-cli machine-validation runs** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Display all machine validation runs + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine-validation runs show +nico-admin-cli machine-validation runs show --machine 12345678-1234-5678-90ab-cdef01234567 --history +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-validation-runs-show.md) | Show Runs | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-add.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-add.md new file mode 100644 index 0000000000..f018b3d864 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-add.md @@ -0,0 +1,123 @@ +# `nico-admin-cli machine-validation tests add` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [tests](./machine-validation-tests.md) › **add**_ + +## NAME + +nico-admin-cli-machine-validation-tests-add - Add new test case + +## SYNOPSIS + +**nico-admin-cli machine-validation tests add** \<**--name**\> +\<**--command**\> \<**--args**\> \[**--contexts**\] \[**--img-name**\] +\[**--execute-in-host**\] \[**--container-arg**\] \[**--description**\] +\[**--extra-err-file**\] \[**--extra-output-file**\] +\[**--external-config-file**\] \[**--pre-condition**\] \[**--timeout**\] +\[**--extended**\] \[**--supported-platforms**\] \[**--custom-tags**\] +\[**--components**\] \[**--is-enabled**\] \[**--read-only**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add new test case + +## OPTIONS + +**--name** *\* +Name of the test case + +**--command** *\* +Command of the test case + +**--args** *\* +Command args + +**--contexts** *\* +List of contexts + +**--img-name** *\* +Container image name + +**--execute-in-host** *\* +Run command using chroot in case of container\ + +\ +*Possible values:* + +- true + +- false + +**--container-arg** *\* +Container args + +**--description** *\* +Description + +**--extra-err-file** *\* +Command output error file + +**--extra-output-file** *\* +Command output file + +**--external-config-file** *\* +External file + +**--pre-condition** *\* +Pre condition + +**--timeout** *\* +Command Timeout + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--supported-platforms** *\* +List of supported platforms + +**--custom-tags** *\* +List of custom tags + +**--components** *\* +List of system components + +**--is-enabled** *\* +Enable the test\ + +\ +*Possible values:* + +- true + +- false + +**--read-only** *\* +Is read-only\ + +\ +*Possible values:* + +- true + +- false + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-disable.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-disable.md new file mode 100644 index 0000000000..d409ea2b53 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-disable.md @@ -0,0 +1,49 @@ +# `nico-admin-cli machine-validation tests disable` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [tests](./machine-validation-tests.md) › **disable**_ + +## NAME + +nico-admin-cli-machine-validation-tests-disable - Disable a test + +## SYNOPSIS + +**nico-admin-cli machine-validation tests disable** +\<**-t**\|**--test-id**\> \<**-v**\|**--version**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Disable a test + +## OPTIONS + +**-t**, **--test-id** *\* +Unique identification of the test + +**-v**, **--version** *\* +Version to be verify + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-enable.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-enable.md new file mode 100644 index 0000000000..66aac01a19 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-enable.md @@ -0,0 +1,49 @@ +# `nico-admin-cli machine-validation tests enable` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [tests](./machine-validation-tests.md) › **enable**_ + +## NAME + +nico-admin-cli-machine-validation-tests-enable - Enabled a test + +## SYNOPSIS + +**nico-admin-cli machine-validation tests enable** +\<**-t**\|**--test-id**\> \<**-v**\|**--version**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enabled a test + +## OPTIONS + +**-t**, **--test-id** *\* +Unique identification of the test + +**-v**, **--version** *\* +Version to be verify + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-show.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-show.md new file mode 100644 index 0000000000..d3025ef8ba --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-show.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine-validation tests show` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [tests](./machine-validation-tests.md) › **show**_ + +## NAME + +nico-admin-cli-machine-validation-tests-show - Show tests + +## SYNOPSIS + +**nico-admin-cli machine-validation tests show** +\[**-t**\|**--test-id**\] \[**-p**\|**--platforms**\] +\[**-c**\|**--contexts**\] \[**--show-un-verfied**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show tests + +## OPTIONS + +**-t**, **--test-id** *\* +Unique identification of the test + +**-p**, **--platforms** *\* +List of platforms + +**-c**, **--contexts** *\* +List of contexts/tags + +**--show-un-verfied** +List unverfied tests also. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-update.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-update.md new file mode 100644 index 0000000000..684418ef9f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-update.md @@ -0,0 +1,117 @@ +# `nico-admin-cli machine-validation tests update` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [tests](./machine-validation-tests.md) › **update**_ + +## NAME + +nico-admin-cli-machine-validation-tests-update - Update existing test +case + +## SYNOPSIS + +**nico-admin-cli machine-validation tests update** \<**--test-id**\> +\<**--version**\> \[**--contexts**\] \[**--img-name**\] +\[**--execute-in-host**\] \[**--container-arg**\] \[**--description**\] +\[**--command**\] \[**--args**\] \[**--extra-err-file**\] +\[**--extra-output-file**\] \[**--external-config-file**\] +\[**--pre-condition**\] \[**--extended**\] \[**--timeout**\] +\[**--supported-platforms**\] \[**--custom-tags**\] \[**--components**\] +\[**--is-enabled**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Update existing test case + +## OPTIONS + +**--test-id** *\* +Unique identification of the test + +**--version** *\* +Version to be verify + +**--contexts** *\* +List of contexts + +**--img-name** *\* +Container image name + +**--execute-in-host** *\* +Run command using chroot in case of container\ + +\ +*Possible values:* + +- true + +- false + +**--container-arg** *\* +Container args + +**--description** *\* +Description + +**--command** *\* +Command + +**--args** *\* +Command args + +**--extra-err-file** *\* +Command output error file + +**--extra-output-file** *\* +Command output file + +**--external-config-file** *\* +External file + +**--pre-condition** *\* +Pre condition + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--timeout** *\* +Command Timeout + +**--supported-platforms** *\* +List of supported platforms + +**--custom-tags** *\* +List of custom tags + +**--components** *\* +List of system components + +**--is-enabled** *\* +Enable the test\ + +\ +*Possible values:* + +- true + +- false + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-verify.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-verify.md new file mode 100644 index 0000000000..cac6c4604a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests-verify.md @@ -0,0 +1,49 @@ +# `nico-admin-cli machine-validation tests verify` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › [tests](./machine-validation-tests.md) › **verify**_ + +## NAME + +nico-admin-cli-machine-validation-tests-verify - Verify a given test + +## SYNOPSIS + +**nico-admin-cli machine-validation tests verify** +\<**-t**\|**--test-id**\> \<**-v**\|**--version**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Verify a given test + +## OPTIONS + +**-t**, **--test-id** *\* +Unique identification of the test + +**-v**, **--version** *\* +Version to be verify + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests.md new file mode 100644 index 0000000000..7a82df14e8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation-tests.md @@ -0,0 +1,62 @@ +# `nico-admin-cli machine-validation tests` + +_[Hardware commands](../../hardware.md) › [machine-validation](./machine-validation.md) › **tests**_ + +## NAME + +nico-admin-cli-machine-validation-tests - Supported Tests + +## SYNOPSIS + +**nico-admin-cli machine-validation tests** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Supported Tests + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine-validation tests show +nico-admin-cli machine-validation tests verify --test-id gpu_bandwidth --version 1.2.0 +nico-admin-cli machine-validation tests enable --test-id gpu_bandwidth --version 1.2.0 +nico-admin-cli machine-validation tests disable --test-id gpu_bandwidth --version 1.2.0 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-validation-tests-show.md) | Show tests | +| [`verify`](./machine-validation-tests-verify.md) | Verify a given test | +| [`add`](./machine-validation-tests-add.md) | Add new test case | +| [`update`](./machine-validation-tests-update.md) | Update existing test case | +| [`enable`](./machine-validation-tests-enable.md) | Enabled a test | +| [`disable`](./machine-validation-tests-disable.md) | Disable a test | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation.md b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation.md new file mode 100644 index 0000000000..b9ce4ef284 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine-validation/machine-validation.md @@ -0,0 +1,52 @@ +# `nico-admin-cli machine-validation` + +_[Hardware commands](../../hardware.md) › **machine-validation**_ + +## NAME + +nico-admin-cli-machine-validation - Machine Validation + +## SYNOPSIS + +**nico-admin-cli machine-validation** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Machine Validation + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`external-config`](./machine-validation-external-config.md) | External config | +| [`on-demand`](./machine-validation-on-demand.md) | Ondemand Validation | +| [`results`](./machine-validation-results.md) | Display machine validation results of individual runs | +| [`runs`](./machine-validation-runs.md) | Display all machine validation runs | +| [`tests`](./machine-validation-tests.md) | Supported Tests | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-auto-update.md b/docs/manuals/nico-admin-cli/commands/machine/machine-auto-update.md new file mode 100644 index 0000000000..82b0bc6c7c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-auto-update.md @@ -0,0 +1,67 @@ +# `nico-admin-cli machine auto-update` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **auto-update**_ + +## NAME + +nico-admin-cli-machine-auto-update - Set individual machine firmware +autoupdate (host only) + +## SYNOPSIS + +**nico-admin-cli machine auto-update** \<**--machine**\> +\[**-e**\|**--enable**\] \[**-d**\|**--disable**\] +\[**-c**\|**--clear**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Set individual machine firmware autoupdate (host only) + +## OPTIONS + +**--machine** *\* +Machine ID of the host to change + +**-e**, **--enable** +Enable auto updates even if globally disabled or individually disabled +by config files + +**-d**, **--disable** +Disable auto updates even if globally enabled or individually enabled by +config files + +**-c**, **--clear** +Perform auto updates according to config files + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --enable +nico-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --disable +nico-admin-cli machine auto-update --machine 12345678-1234-5678-90ab-cdef01234567 --clear +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-force-delete.md b/docs/manuals/nico-admin-cli/commands/machine/machine-force-delete.md new file mode 100644 index 0000000000..6c6558a3eb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-force-delete.md @@ -0,0 +1,75 @@ +# `nico-admin-cli machine force-delete` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **force-delete**_ + +## NAME + +nico-admin-cli-machine-force-delete - Force delete a machine + +## SYNOPSIS + +**nico-admin-cli machine force-delete** \<**--machine**\> +\[**-d**\|**--delete-interfaces**\] +\[**-b**\|**--delete-bmc-interfaces**\] +\[**-c**\|**--delete-bmc-credentials**\] +\[**--allow-delete-with-instance**\] +\[**--allow-delete-with-orphaned-dpf-crds**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Force delete a machine + +## OPTIONS + +**--machine** *\* +UUID, IPv4, MAC or hostnmame of the host or DPU machine to delete + +**-d**, **--delete-interfaces** +Delete interfaces. Redeploy kea after deleting machine interfaces. + +**-b**, **--delete-bmc-interfaces** +Delete BMC interfaces. Redeploy kea after deleting machine interfaces. + +**-c**, **--delete-bmc-credentials** +Delete BMC credentials. Only applicable if site explorer has configured +credentials for the BMCs associated with this managed host. + +**--allow-delete-with-instance** +Delete machine with allocated instance. This flag acknowledges +destroying the user instance as well. + +**--allow-delete-with-orphaned-dpf-crds** +Delete machine even if DPF CRDs exist and DPF is disabled at the site +level. This flag acknowledges that orphaned DPF resources may remain + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine force-delete --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine force-delete --machine 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-show.md b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-show.md new file mode 100644 index 0000000000..9f8acdbc7b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-show.md @@ -0,0 +1,46 @@ +# `nico-admin-cli machine hardware-info show` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [hardware-info](./machine-hardware-info.md) › **show**_ + +## NAME + +nico-admin-cli-machine-hardware-info-show - Show the hardware info of +the machine + +## SYNOPSIS + +**nico-admin-cli machine hardware-info show** \<**--machine**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show the hardware info of the machine + +## OPTIONS + +**--machine** *\* +Show the hardware info of this Machine ID + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-update-gpus.md b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-update-gpus.md new file mode 100644 index 0000000000..ef40742c20 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-update-gpus.md @@ -0,0 +1,55 @@ +# `nico-admin-cli machine hardware-info update gpus` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [hardware-info](./machine-hardware-info.md) › [update](./machine-hardware-info-update.md) › **gpus**_ + +## NAME + +nico-admin-cli-machine-hardware-info-update-gpus - Update the GPUs of +this machine + +## SYNOPSIS + +**nico-admin-cli machine hardware-info update gpus** \<**--machine**\> +\<**--gpu-json-file**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update the GPUs of this machine + +## OPTIONS + +**--machine** *\* +Machine ID of the server containing the GPUs + +**--gpu-json-file** *\* +JSON file containing GPU info. It should contain an array of JSON +objects like this: { "name": "string", "serial": "string", +"driver_version": "string", "vbios_version": "string", +"inforom_version": "string", "total_memory": "string", "frequency": +"string", "pci_bus_id": "string" } Pass an empty array if you want to +remove GPUs. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-update.md b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-update.md new file mode 100644 index 0000000000..23406f127f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info-update.md @@ -0,0 +1,49 @@ +# `nico-admin-cli machine hardware-info update` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [hardware-info](./machine-hardware-info.md) › **update**_ + +## NAME + +nico-admin-cli-machine-hardware-info-update - Update the hardware info +of the machine + +## SYNOPSIS + +**nico-admin-cli machine hardware-info update** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Update the hardware info of the machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`gpus`](./machine-hardware-info-update-gpus.md) | Update the GPUs of this machine | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info.md b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info.md new file mode 100644 index 0000000000..0c05bed07d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-hardware-info.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine hardware-info` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **hardware-info**_ + +## NAME + +nico-admin-cli-machine-hardware-info - Update/show machine hardware info + +## SYNOPSIS + +**nico-admin-cli machine hardware-info** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Update/show machine hardware info + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine hardware-info show --machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine hardware-info update gpus --machine 12345678-1234-5678-90ab-cdef01234567 --gpu-json-file ./gpus.json +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-hardware-info-show.md) | Show the hardware info of the machine | +| [`update`](./machine-hardware-info-update.md) | Update the hardware info of the machine | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-add.md b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-add.md new file mode 100644 index 0000000000..6df435c510 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-add.md @@ -0,0 +1,86 @@ +# `nico-admin-cli machine health-report add` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [health-report](./machine-health-report.md) › **add**_ + +## NAME + +nico-admin-cli-machine-health-report-add - Insert a health report entry + +## SYNOPSIS + +**nico-admin-cli machine health-report add** \[**--health-report**\] +\[**--template**\] \[**--message**\] \[**--replace**\] +\[**--print-only**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Insert a health report entry + +## OPTIONS + +**--health-report** *\* +New health report as json + +**--template** *\* +Predefined Template name. Use host-update for DPU Reprovision\ + +\ +*Possible values:* + +- host-update + +- internal-maintenance + +- out-for-repair + +- degraded + +- validation + +- suppress-external-alerting + +- mark-healthy + +- stop-reboot-for-automatic-recovery-from-state-machine + +- tenant-reported-issue + +- request-online-repair + +- request-repair + +**--message** *\* +Message to be filled in template. + +**--replace** +Replace all other health reports with this source + +**--print-only** +Print the template that is going to be send to carbide + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-print-empty-template.md b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-print-empty-template.md new file mode 100644 index 0000000000..fda55d156f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-print-empty-template.md @@ -0,0 +1,43 @@ +# `nico-admin-cli machine health-report print-empty-template` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [health-report](./machine-health-report.md) › **print-empty-template**_ + +## NAME + +nico-admin-cli-machine-health-report-print-empty-template - Print an +empty health report template, which user can modify and use + +## SYNOPSIS + +**nico-admin-cli machine health-report print-empty-template** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print an empty health report template, which user can modify and use + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-remove.md b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-remove.md new file mode 100644 index 0000000000..14997d797b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-remove.md @@ -0,0 +1,48 @@ +# `nico-admin-cli machine health-report remove` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [health-report](./machine-health-report.md) › **remove**_ + +## NAME + +nico-admin-cli-machine-health-report-remove - Remove a health report +entry + +## SYNOPSIS + +**nico-admin-cli machine health-report remove** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*REPORT_SOURCE*\> + +## DESCRIPTION + +Remove a health report entry + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +\<*REPORT_SOURCE*\> + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-show.md b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-show.md new file mode 100644 index 0000000000..0c52c8326d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report-show.md @@ -0,0 +1,45 @@ +# `nico-admin-cli machine health-report show` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [health-report](./machine-health-report.md) › **show**_ + +## NAME + +nico-admin-cli-machine-health-report-show - List the health report +entries + +## SYNOPSIS + +**nico-admin-cli machine health-report show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +List the health report entries + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-health-report.md b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report.md new file mode 100644 index 0000000000..a7ffe2851f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-health-report.md @@ -0,0 +1,60 @@ +# `nico-admin-cli machine health-report` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **health-report**_ + +## NAME + +nico-admin-cli-machine-health-report - Manage health report sources + +## SYNOPSIS + +**nico-admin-cli machine health-report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage health report sources + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine health-report show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance --message "Firmware upgrade in progress" +nico-admin-cli machine health-report remove 12345678-1234-5678-90ab-cdef01234567 internal-maintenance +nico-admin-cli machine health-report print-empty-template +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-health-report-show.md) | List the health report entries | +| [`add`](./machine-health-report-add.md) | Insert a health report entry | +| [`print-empty-template`](./machine-health-report-print-empty-template.md) | Print an empty health report template, which user can modify and use | +| [`remove`](./machine-health-report-remove.md) | Remove a health report entry | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-add-label.md b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-add-label.md new file mode 100644 index 0000000000..22885e4f46 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-add-label.md @@ -0,0 +1,60 @@ +# `nico-admin-cli machine metadata add-label` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [metadata](./machine-metadata.md) › **add-label**_ + +## NAME + +nico-admin-cli-machine-metadata-add-label - Adds a label to the Metadata +of a Machine + +## SYNOPSIS + +**nico-admin-cli machine metadata add-label** \<**--key**\> +\[**--value**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE*\> + +## DESCRIPTION + +Adds a label to the Metadata of a Machine + +## OPTIONS + +**--key** *\* +The key to add + +**--value** *\* +The optional value to add + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE*\> +The machine which should get updated metadata + +## Examples + +```sh +nico-admin-cli machine metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge +nico-admin-cli machine metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key rack --value 4 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-from-expected-machine.md b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-from-expected-machine.md new file mode 100644 index 0000000000..adba406762 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-from-expected-machine.md @@ -0,0 +1,66 @@ +# `nico-admin-cli machine metadata from-expected-machine` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [metadata](./machine-metadata.md) › **from-expected-machine**_ + +## NAME + +nico-admin-cli-machine-metadata-from-expected-machine - Copy Machine +Metadata from Expected-Machine to Machine + +## SYNOPSIS + +**nico-admin-cli machine metadata from-expected-machine** +\[**--replace-all**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE*\> + +## DESCRIPTION + +Copy Machine Metadata from Expected-Machine to Machine + +## OPTIONS + +**--replace-all** +Whether to fully replace the Metadata that is currently stored on the +Machine. - If not set, existing Metadata on the Machine will not be +touched by executing the command: - The existing Name will not be +changed if the Name is not equivalent to the Machine ID or Empty. - The +existing Description will not be changed if it is not empty. - Existing +Labels and their values will not be changed. Only labels which do not +exist on the Machine will be added. - If set, the Machines Metadata will +be set to the same values as they would if the Machine would get freshly +ingested. Metadata that is currently set on the Machine will be +overridden. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE*\> +The machine which should get updated metadata + +## Examples + +```sh +nico-admin-cli machine metadata from-expected-machine 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine metadata from-expected-machine 12345678-1234-5678-90ab-cdef01234567 --replace-all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-remove-labels.md b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-remove-labels.md new file mode 100644 index 0000000000..c2c3175a4c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-remove-labels.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine metadata remove-labels` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [metadata](./machine-metadata.md) › **remove-labels**_ + +## NAME + +nico-admin-cli-machine-metadata-remove-labels - Removes labels from the +Metadata of a Machine + +## SYNOPSIS + +**nico-admin-cli machine metadata remove-labels** \[**--keys**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE*\> + +## DESCRIPTION + +Removes labels from the Metadata of a Machine + +## OPTIONS + +**--keys** *\* +The keys to remove + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE*\> +The machine which should get updated metadata + +## Examples + +```sh +nico-admin-cli machine metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 --keys rack --keys edge +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-set.md b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-set.md new file mode 100644 index 0000000000..00121ea7bf --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-set.md @@ -0,0 +1,59 @@ +# `nico-admin-cli machine metadata set` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [metadata](./machine-metadata.md) › **set**_ + +## NAME + +nico-admin-cli-machine-metadata-set - Set the Name or Description of the +Machine + +## SYNOPSIS + +**nico-admin-cli machine metadata set** \[**--name**\] +\[**--description**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE*\> + +## DESCRIPTION + +Set the Name or Description of the Machine + +## OPTIONS + +**--name** *\* +The updated name of the Machine + +**--description** *\* +The updated description of the Machine + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE*\> +The machine which should get updated metadata + +## Examples + +```sh +nico-admin-cli machine metadata set 12345678-1234-5678-90ab-cdef01234567 --name gpu-node-01 --description "Rack 4, tray 2" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-show.md b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-show.md new file mode 100644 index 0000000000..e6aa5df5e5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata-show.md @@ -0,0 +1,51 @@ +# `nico-admin-cli machine metadata show` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [metadata](./machine-metadata.md) › **show**_ + +## NAME + +nico-admin-cli-machine-metadata-show - Show the Metadata of the Machine + +## SYNOPSIS + +**nico-admin-cli machine metadata show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE*\> + +## DESCRIPTION + +Show the Metadata of the Machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE*\> +The machine which should get updated metadata + +## Examples + +```sh +nico-admin-cli machine metadata show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-metadata.md b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata.md new file mode 100644 index 0000000000..bbd97ee7e1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-metadata.md @@ -0,0 +1,53 @@ +# `nico-admin-cli machine metadata` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **metadata**_ + +## NAME + +nico-admin-cli-machine-metadata - Edit Metadata associated with a +Machine + +## SYNOPSIS + +**nico-admin-cli machine metadata** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Edit Metadata associated with a Machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set`](./machine-metadata-set.md) | Set the Name or Description of the Machine | +| [`show`](./machine-metadata-show.md) | Show the Metadata of the Machine | +| [`add-label`](./machine-metadata-add-label.md) | Adds a label to the Metadata of a Machine | +| [`remove-labels`](./machine-metadata-remove-labels.md) | Removes labels from the Metadata of a Machine | +| [`from-expected-machine`](./machine-metadata-from-expected-machine.md) | Copy Machine Metadata from Expected-Machine to Machine | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-network-config.md b/docs/manuals/nico-admin-cli/commands/machine/machine-network-config.md new file mode 100644 index 0000000000..280c977fde --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-network-config.md @@ -0,0 +1,46 @@ +# `nico-admin-cli machine network config` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [network](./machine-network.md) › **config**_ + +## NAME + +nico-admin-cli-machine-network-config - Machine network configuration, +used by VPC. + +## SYNOPSIS + +**nico-admin-cli machine network config** \<**--machine-id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Machine network configuration, used by VPC. + +## OPTIONS + +**--machine-id** *\* +DPU machine id + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-network-status.md b/docs/manuals/nico-admin-cli/commands/machine/machine-network-status.md new file mode 100644 index 0000000000..f6fff28838 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-network-status.md @@ -0,0 +1,43 @@ +# `nico-admin-cli machine network status` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [network](./machine-network.md) › **status**_ + +## NAME + +nico-admin-cli-machine-network-status - Print network status of all +machines + +## SYNOPSIS + +**nico-admin-cli machine network status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print network status of all machines + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-network.md b/docs/manuals/nico-admin-cli/commands/machine/machine-network.md new file mode 100644 index 0000000000..8fed019269 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-network.md @@ -0,0 +1,56 @@ +# `nico-admin-cli machine network` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **network**_ + +## NAME + +nico-admin-cli-machine-network - Networking information + +## SYNOPSIS + +**nico-admin-cli machine network** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Networking information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine network status +nico-admin-cli machine network config --machine-id 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`status`](./machine-network-status.md) | Print network status of all machines | +| [`config`](./machine-network-config.md) | Machine network configuration, used by VPC. | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info-populate.md b/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info-populate.md new file mode 100644 index 0000000000..c64aa730f3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info-populate.md @@ -0,0 +1,50 @@ +# `nico-admin-cli machine nvlink-info populate` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [nvlink-info](./machine-nvlink-info.md) › **populate**_ + +## NAME + +nico-admin-cli-machine-nvlink-info-populate - Build NVLink info from +Redfish + NMX-C and populate DB + +## SYNOPSIS + +**nico-admin-cli machine nvlink-info populate** \[**--update-db**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> + +## DESCRIPTION + +Build NVLink info from Redfish + NMX-C and populate DB + +## OPTIONS + +**--update-db** +Update the database with the nvlink_info + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine ID to populate + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info-show.md b/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info-show.md new file mode 100644 index 0000000000..561ac54683 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info-show.md @@ -0,0 +1,45 @@ +# `nico-admin-cli machine nvlink-info show` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › [nvlink-info](./machine-nvlink-info.md) › **show**_ + +## NAME + +nico-admin-cli-machine-nvlink-info-show - Show existing NVLink info + +## SYNOPSIS + +**nico-admin-cli machine nvlink-info show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Show existing NVLink info + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Machine ID to query + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info.md b/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info.md new file mode 100644 index 0000000000..9cf4475927 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-nvlink-info.md @@ -0,0 +1,57 @@ +# `nico-admin-cli machine nvlink-info` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **nvlink-info**_ + +## NAME + +nico-admin-cli-machine-nvlink-info - Update/show NVLink info for an +MNNVL machine + +## SYNOPSIS + +**nico-admin-cli machine nvlink-info** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Update/show NVLink info for an MNNVL machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine nvlink-info show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine nvlink-info populate 12345678-1234-5678-90ab-cdef01234567 --update-db +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-nvlink-info-show.md) | Show existing NVLink info | +| [`populate`](./machine-nvlink-info-populate.md) | Build NVLink info from Redfish + NMX-C and populate DB | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-positions.md b/docs/manuals/nico-admin-cli/commands/machine/machine-positions.md new file mode 100644 index 0000000000..64d07bf88e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-positions.md @@ -0,0 +1,59 @@ +# `nico-admin-cli machine positions` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **positions**_ + +## NAME + +nico-admin-cli-machine-positions - Show physical location info for +machines in rack-based systems + +## SYNOPSIS + +**nico-admin-cli machine positions** \[**-m**\|**--machine**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show physical location info for machines in rack-based systems. + +Returns rack topology information including: - Physical slot number: The +slot position in the rack - Compute tray index: The compute tray +containing this machine - Topology ID: Identifier for the rack topology +configuration - Revision ID: Hardware revision identifier - Switch ID: +Associated network switch - Power shelf ID: Associated power shelf + +## OPTIONS + +**-m**, **--machine** \[*\...*\] +The machine(s) to query, leave empty for all (default) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine positions +nico-admin-cli machine positions --machine 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-reboot.md b/docs/manuals/nico-admin-cli/commands/machine/machine-reboot.md new file mode 100644 index 0000000000..5e3e041542 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-reboot.md @@ -0,0 +1,51 @@ +# `nico-admin-cli machine reboot` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **reboot**_ + +## NAME + +nico-admin-cli-machine-reboot - Reboot a machine + +## SYNOPSIS + +**nico-admin-cli machine reboot** \<**--machine**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Reboot a machine + +## OPTIONS + +**--machine** *\* +ID of the machine to reboot + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli machine reboot --machine 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine-show.md b/docs/manuals/nico-admin-cli/commands/machine/machine-show.md new file mode 100644 index 0000000000..efe680fe26 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine-show.md @@ -0,0 +1,69 @@ +# `nico-admin-cli machine show` + +_[Hardware commands](../../hardware.md) › [machine](./machine.md) › **show**_ + +## NAME + +nico-admin-cli-machine-show - Display Machine information + +## SYNOPSIS + +**nico-admin-cli machine show** \[**--help**\] \[**-a**\|**--all**\] +\[**-d**\|**--dpus**\] \[**-h**\|**--hosts**\] +\[**-t**\|**--instance-type-id**\] \[**-c**\|**--history-count**\] +\[**--extended**\] \[**--sort-by**\] \[*MACHINE*\] + +## DESCRIPTION + +Display Machine information + +## OPTIONS + +**--help** +**-a**, **--all** +Show all machines (DEPRECATED) + +**-d**, **--dpus** +Show only DPUs + +**-h**, **--hosts** +Show only hosts + +**-t**, **--instance-type-id** *\* +Show only machines for this instance type + +**-c**, **--history-count** *\* \[default: 5\] +History count. Valid if \`machine\` argument is passed. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +\[*MACHINE*\] +The machine ID to query. Omit to show all machines. + +## Examples + +```sh +nico-admin-cli machine show +nico-admin-cli machine show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli machine show --dpus +nico-admin-cli machine show --hosts +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/machine/machine.md b/docs/manuals/nico-admin-cli/commands/machine/machine.md new file mode 100644 index 0000000000..909fadb898 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/machine/machine.md @@ -0,0 +1,57 @@ +# `nico-admin-cli machine` + +_[Hardware commands](../../hardware.md) › **machine**_ + +## NAME + +nico-admin-cli-machine - Machine related handling + +## SYNOPSIS + +**nico-admin-cli machine** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Machine related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./machine-show.md) | Display Machine information | +| [`network`](./machine-network.md) | Networking information | +| [`health-report`](./machine-health-report.md) | Manage health report sources | +| [`reboot`](./machine-reboot.md) | Reboot a machine | +| [`force-delete`](./machine-force-delete.md) | Force delete a machine | +| [`auto-update`](./machine-auto-update.md) | Set individual machine firmware autoupdate (host only) | +| [`metadata`](./machine-metadata.md) | Edit Metadata associated with a Machine | +| [`hardware-info`](./machine-hardware-info.md) | Update/show machine hardware info | +| [`positions`](./machine-positions.md) | Show physical location info for machines in rack-based systems | +| [`nvlink-info`](./machine-nvlink-info.md) | Update/show NVLink info for an MNNVL machine | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-debug-bundle.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-debug-bundle.md new file mode 100644 index 0000000000..434317af20 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-debug-bundle.md @@ -0,0 +1,77 @@ +# `nico-admin-cli managed-host debug-bundle` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **debug-bundle**_ + +## NAME + +nico-admin-cli-managed-host-debug-bundle - Download debug bundle with +logs for a specific host + +## SYNOPSIS + +**nico-admin-cli managed-host debug-bundle** \<**--start-time**\> +\[**--end-time**\] \[**--utc**\] \[**--output-path**\] +\[**--grafana-url**\] \[**--batch-size**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*HOST_ID*\> + +## DESCRIPTION + +Download debug bundle with logs for a specific host + +## OPTIONS + +**--start-time** *\* +Start time: YYYY-MM-DD HH:MM:SS or HH:MM:SS (uses todays date). Default: +local timezone, use --utc for UTC + +**--end-time** *\* +End time: YYYY-MM-DD HH:MM:SS or HH:MM:SS (uses todays date). Defaults +to current time if not provided. Default: local timezone, use --utc for +UTC + +**--utc** +Interpret start-time and end-time as UTC instead of local timezone + +**--output-path** *\* \[default: /tmp\] +Output directory path for the debug bundle (default: /tmp) + +**--grafana-url** *\* +Grafana base URL (e.g., https://grafana.example.com). If not provided, +log collection is skipped. + +**--batch-size** *\* \[default: 5000\] +Batch size for log collection (default: 5000, max: 5000) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*HOST_ID*\> +The host machine ID to collect logs for + +## Examples + +```sh +nico-admin-cli managed-host debug-bundle 12345678-1234-5678-90ab-cdef01234567 --start-time "2026-01-02 03:04:05" --end-time "2026-01-02 04:00:00" +nico-admin-cli managed-host debug-bundle 12345678-1234-5678-90ab-cdef01234567 --start-time 03:04:05 --utc +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance-off.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance-off.md new file mode 100644 index 0000000000..a992b6f54a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance-off.md @@ -0,0 +1,52 @@ +# `nico-admin-cli managed-host maintenance off` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [maintenance](./managed-host-maintenance.md) › **off**_ + +## NAME + +nico-admin-cli-managed-host-maintenance-off - Return this machine to +normal operation + +## SYNOPSIS + +**nico-admin-cli managed-host maintenance off** \<**--host**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Return this machine to normal operation + +## OPTIONS + +**--host** *\* +Managed Host ID + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host maintenance off --host 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance-on.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance-on.md new file mode 100644 index 0000000000..677ef28391 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance-on.md @@ -0,0 +1,57 @@ +# `nico-admin-cli managed-host maintenance on` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [maintenance](./managed-host-maintenance.md) › **on**_ + +## NAME + +nico-admin-cli-managed-host-maintenance-on - Put this machine into +maintenance mode. Prevents an instance being assigned to it + +## SYNOPSIS + +**nico-admin-cli managed-host maintenance on** \<**--host**\> +\<**--reference**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Put this machine into maintenance mode. Prevents an instance being +assigned to it + +## OPTIONS + +**--host** *\* +Managed Host ID + +**--reference** *\* +URL of reference (ticket, issue, etc) for this machines maintenance + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host maintenance on --host 12345678-1234-5678-90ab-cdef01234567 --reference https://tickets.example.com/MH-42 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance.md new file mode 100644 index 0000000000..6973162835 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-maintenance.md @@ -0,0 +1,50 @@ +# `nico-admin-cli managed-host maintenance` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **maintenance**_ + +## NAME + +nico-admin-cli-managed-host-maintenance - Switch a machine in/out of +maintenance mode + +## SYNOPSIS + +**nico-admin-cli managed-host maintenance** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Switch a machine in/out of maintenance mode + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`on`](./managed-host-maintenance-on.md) | Put this machine into maintenance mode. Prevents an instance being assigned to it | +| [`off`](./managed-host-maintenance-off.md) | Return this machine to normal operation | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-allow-ingestion-and-power-on.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-allow-ingestion-and-power-on.md new file mode 100644 index 0000000000..79926a8756 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-allow-ingestion-and-power-on.md @@ -0,0 +1,53 @@ +# `nico-admin-cli managed-host power-options allow-ingestion-and-power-on` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [power-options](./managed-host-power-options.md) › **allow-ingestion-and-power-on**_ + +## NAME + +nico-admin-cli-managed-host-power-options-allow-ingestion-and-power-on - +Allow a machine to power on + +## SYNOPSIS + +**nico-admin-cli managed-host power-options +allow-ingestion-and-power-on** \<**-m**\|**--mac-address**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Allow a machine to power on + +## OPTIONS + +**-m**, **--mac-address** *\* +MAC Address of host BMC endpoint + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host power-options allow-ingestion-and-power-on --mac-address 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-get-machine-ingestion-state.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-get-machine-ingestion-state.md new file mode 100644 index 0000000000..6e760816c9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-get-machine-ingestion-state.md @@ -0,0 +1,53 @@ +# `nico-admin-cli managed-host power-options get-machine-ingestion-state` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [power-options](./managed-host-power-options.md) › **get-machine-ingestion-state**_ + +## NAME + +nico-admin-cli-managed-host-power-options-get-machine-ingestion-state - +Get machine ingestion state + +## SYNOPSIS + +**nico-admin-cli managed-host power-options +get-machine-ingestion-state** \<**-m**\|**--mac-address**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get machine ingestion state + +## OPTIONS + +**-m**, **--mac-address** *\* +MAC Address of host BMC endpoint + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host power-options get-machine-ingestion-state --mac-address 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-show.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-show.md new file mode 100644 index 0000000000..147bc726e5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-show.md @@ -0,0 +1,50 @@ +# `nico-admin-cli managed-host power-options show` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [power-options](./managed-host-power-options.md) › **show**_ + +## NAME + +nico-admin-cli-managed-host-power-options-show + +## SYNOPSIS + +**nico-admin-cli managed-host power-options show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*MACHINE*\] + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*MACHINE*\] +ID of the host or nothing for all + +## Examples + +```sh +nico-admin-cli managed-host power-options show +nico-admin-cli managed-host power-options show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-update.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-update.md new file mode 100644 index 0000000000..ada60dd210 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options-update.md @@ -0,0 +1,62 @@ +# `nico-admin-cli managed-host power-options update` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [power-options](./managed-host-power-options.md) › **update**_ + +## NAME + +nico-admin-cli-managed-host-power-options-update + +## SYNOPSIS + +**nico-admin-cli managed-host power-options update** +\<**-d**\|**--desired-power-state**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE*\> + +## DESCRIPTION + +## OPTIONS + +**-d**, **--desired-power-state** *\* +Desired Power State\ + +\ +*Possible values:* + +- on + +- off + +- power-manager-disabled + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE*\> +ID of the host + +## Examples + +```sh +nico-admin-cli managed-host power-options update 12345678-1234-5678-90ab-cdef01234567 --desired-power-state off +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options.md new file mode 100644 index 0000000000..d9bb3d12f8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-power-options.md @@ -0,0 +1,52 @@ +# `nico-admin-cli managed-host power-options` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **power-options**_ + +## NAME + +nico-admin-cli-managed-host-power-options - Power Manager related +settings. + +## SYNOPSIS + +**nico-admin-cli managed-host power-options** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Power Manager related settings. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./managed-host-power-options-show.md) | | +| [`update`](./managed-host-power-options-update.md) | | +| [`get-machine-ingestion-state`](./managed-host-power-options-get-machine-ingestion-state.md) | Get machine ingestion state | +| [`allow-ingestion-and-power-on`](./managed-host-power-options-allow-ingestion-and-power-on.md) | Allow a machine to power on | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine-off.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine-off.md new file mode 100644 index 0000000000..559aa693e6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine-off.md @@ -0,0 +1,52 @@ +# `nico-admin-cli managed-host quarantine off` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [quarantine](./managed-host-quarantine.md) › **off**_ + +## NAME + +nico-admin-cli-managed-host-quarantine-off - Take this machine out of +quarantine + +## SYNOPSIS + +**nico-admin-cli managed-host quarantine off** \<**--host**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Take this machine out of quarantine + +## OPTIONS + +**--host** *\* +Managed Host ID + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host quarantine off --host 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine-on.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine-on.md new file mode 100644 index 0000000000..3dd7156bae --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine-on.md @@ -0,0 +1,57 @@ +# `nico-admin-cli managed-host quarantine on` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › [quarantine](./managed-host-quarantine.md) › **on**_ + +## NAME + +nico-admin-cli-managed-host-quarantine-on - Put this machine into +quarantine. Prevents any network access on the host machine + +## SYNOPSIS + +**nico-admin-cli managed-host quarantine on** \<**--host**\> +\<**--reason**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Put this machine into quarantine. Prevents any network access on the +host machine + +## OPTIONS + +**--host** *\* +Managed Host ID + +**--reason** *\* +Reason for quarantining this host + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host quarantine on --host 12345678-1234-5678-90ab-cdef01234567 --reason "suspected compromise" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine.md new file mode 100644 index 0000000000..7c1e9d4e46 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-quarantine.md @@ -0,0 +1,50 @@ +# `nico-admin-cli managed-host quarantine` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **quarantine**_ + +## NAME + +nico-admin-cli-managed-host-quarantine - Quarantine a host (disabling +network access on host) + +## SYNOPSIS + +**nico-admin-cli managed-host quarantine** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Quarantine a host (disabling network access on host) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`on`](./managed-host-quarantine-on.md) | Put this machine into quarantine. Prevents any network access on the host machine | +| [`off`](./managed-host-quarantine-off.md) | Take this machine out of quarantine | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-reset-host-reprovisioning.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-reset-host-reprovisioning.md new file mode 100644 index 0000000000..c7a9250c51 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-reset-host-reprovisioning.md @@ -0,0 +1,53 @@ +# `nico-admin-cli managed-host reset-host-reprovisioning` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **reset-host-reprovisioning**_ + +## NAME + +nico-admin-cli-managed-host-reset-host-reprovisioning - Reset host +reprovisioning back to CheckingFirmware + +## SYNOPSIS + +**nico-admin-cli managed-host reset-host-reprovisioning** +\<**--machine**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Reset host reprovisioning back to CheckingFirmware + +## OPTIONS + +**--machine** *\* +Machine ID to reset host reprovision on + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host reset-host-reprovisioning --machine 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-set-primary-dpu.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-set-primary-dpu.md new file mode 100644 index 0000000000..af1671fdd0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-set-primary-dpu.md @@ -0,0 +1,60 @@ +# `nico-admin-cli managed-host set-primary-dpu` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **set-primary-dpu**_ + +## NAME + +nico-admin-cli-managed-host-set-primary-dpu - Set the primary DPU for +the managed host + +## SYNOPSIS + +**nico-admin-cli managed-host set-primary-dpu** \[**--reboot**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*HOST_MACHINE_ID*\> \<*DPU_MACHINE_ID*\> + +## DESCRIPTION + +Set the primary DPU for the managed host + +## OPTIONS + +**--reboot** +Reboot the host after the update + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*HOST_MACHINE_ID*\> +ID of the host machine + +\<*DPU_MACHINE_ID*\> +ID of the DPU machine to make primary + +## Examples + +```sh +nico-admin-cli managed-host set-primary-dpu 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli managed-host set-primary-dpu 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 --reboot +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-show.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-show.md new file mode 100644 index 0000000000..0c46a0a2ad --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-show.md @@ -0,0 +1,72 @@ +# `nico-admin-cli managed-host show` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **show**_ + +## NAME + +nico-admin-cli-managed-host-show - Display managed host information + +## SYNOPSIS + +**nico-admin-cli managed-host show** \[**--help**\] +\[**-a**\|**--all**\] \[**-i**\|**--ips**\] +\[**-t**\|**--instance-type-id**\] \[**-m**\|**--more**\] \[**--fix**\] +\[**--quarantine**\] \[**--extended**\] \[**--sort-by**\] \[*MACHINE*\] + +## DESCRIPTION + +Display managed host information + +## OPTIONS + +**--help** +**-a**, **--all** +Show all managed hosts (DEPRECATED) + +**-i**, **--ips** +Show IP details in summary + +**-t**, **--instance-type-id** *\* +Show only hosts for this instance type + +**-m**, **--more** +Show GPU and memory details in summary + +**--fix** +Show only hosts in maintenance mode + +**--quarantine** +Show only hosts in quarantine + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +\[*MACHINE*\] +Show managed host specific details (using host or dpu machine id), leave +empty for all + +## Examples + +```sh +nico-admin-cli managed-host show +nico-admin-cli managed-host show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli managed-host show --ips +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-start-updates.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-start-updates.md new file mode 100644 index 0000000000..abf7518932 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host-start-updates.md @@ -0,0 +1,65 @@ +# `nico-admin-cli managed-host start-updates` + +_[Hardware commands](../../hardware.md) › [managed-host](./managed-host.md) › **start-updates**_ + +## NAME + +nico-admin-cli-managed-host-start-updates - Start updates for machines +with delayed updates, such as GB200 + +## SYNOPSIS + +**nico-admin-cli managed-host start-updates** \<**--machines**\> +\[**--start**\] \[**--end**\] \[**--cancel**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Start updates for machines with delayed updates, such as GB200 + +## OPTIONS + +**--machines** *\...* +Machine IDs to update, space separated + +**--start** *\* +Start of the maintenance window for doing the updates (default now) +format 2025-01-02T03:04:05+0000 or 2025-01-02T03:04:05 for local time + +**--end** *\* +End of starting new updates (default 24 hours from the start) format +2025-01-02T03:04:05+0000 or 2025-01-02T03:04:05 for local time + +**--cancel** +Cancel any new updates + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-host start-updates --machines 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli managed-host start-updates --machines 12345678-1234-5678-90ab-cdef01234567 --start 2026-01-02T03:04:05 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-host/managed-host.md b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host.md new file mode 100644 index 0000000000..7cfee87d00 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-host/managed-host.md @@ -0,0 +1,55 @@ +# `nico-admin-cli managed-host` + +_[Hardware commands](../../hardware.md) › **managed-host**_ + +## NAME + +nico-admin-cli-managed-host - Managed host related handling + +## SYNOPSIS + +**nico-admin-cli managed-host** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Managed host related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./managed-host-show.md) | Display managed host information | +| [`maintenance`](./managed-host-maintenance.md) | Switch a machine in/out of maintenance mode | +| [`quarantine`](./managed-host-quarantine.md) | Quarantine a host (disabling network access on host) | +| [`reset-host-reprovisioning`](./managed-host-reset-host-reprovisioning.md) | Reset host reprovisioning back to CheckingFirmware | +| [`power-options`](./managed-host-power-options.md) | Power Manager related settings. | +| [`start-updates`](./managed-host-start-updates.md) | Start updates for machines with delayed updates, such as GB200 | +| [`set-primary-dpu`](./managed-host-set-primary-dpu.md) | Set the primary DPU for the managed host | +| [`debug-bundle`](./managed-host-debug-bundle.md) | Download debug bundle with logs for a specific host | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-delete.md b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-delete.md new file mode 100644 index 0000000000..55f1f9e2d8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli managed-switch delete` + +_[Hardware commands](../../hardware.md) › [managed-switch](./managed-switch.md) › **delete**_ + +## NAME + +nico-admin-cli-managed-switch-delete - Delete a managed switch + +## SYNOPSIS + +**nico-admin-cli managed-switch delete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*SWITCH_ID*\> + +## DESCRIPTION + +Delete a managed switch + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH_ID*\> +Switch ID to delete. + +## Examples + +```sh +nico-admin-cli managed-switch delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-list.md b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-list.md new file mode 100644 index 0000000000..0e54abd3ca --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-list.md @@ -0,0 +1,48 @@ +# `nico-admin-cli managed-switch list` + +_[Hardware commands](../../hardware.md) › [managed-switch](./managed-switch.md) › **list**_ + +## NAME + +nico-admin-cli-managed-switch-list - List all managed switches + +## SYNOPSIS + +**nico-admin-cli managed-switch list** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all managed switches + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli managed-switch list +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-show.md b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-show.md new file mode 100644 index 0000000000..2d7797d200 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch-show.md @@ -0,0 +1,59 @@ +# `nico-admin-cli managed-switch show` + +_[Hardware commands](../../hardware.md) › [managed-switch](./managed-switch.md) › **show**_ + +## NAME + +nico-admin-cli-managed-switch-show - Display managed switch information + +## SYNOPSIS + +**nico-admin-cli managed-switch show** \[**-i**\|**--ips**\] +\[**-m**\|**--more**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*IDENTIFIER*\] + +## DESCRIPTION + +Display managed switch information + +## OPTIONS + +**-i**, **--ips** +Show BMC/NVOS MAC details in summary + +**-m**, **--more** +Show serial, power, and health details in summary + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IDENTIFIER*\] +Switch ID or name to show details for (leave empty for all) + +## Examples + +```sh +nico-admin-cli managed-switch show +nico-admin-cli managed-switch show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch.md b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch.md new file mode 100644 index 0000000000..23aaa5234e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/managed-switch/managed-switch.md @@ -0,0 +1,50 @@ +# `nico-admin-cli managed-switch` + +_[Hardware commands](../../hardware.md) › **managed-switch**_ + +## NAME + +nico-admin-cli-managed-switch - Managed switch related handling + +## SYNOPSIS + +**nico-admin-cli managed-switch** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Managed switch related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./managed-switch-show.md) | Display managed switch information | +| [`list`](./managed-switch-list.md) | List all managed switches | +| [`delete`](./managed-switch-delete.md) | Delete a managed switch | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-compare.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-compare.md new file mode 100644 index 0000000000..77ff7ba95e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-compare.md @@ -0,0 +1,54 @@ +# `nico-admin-cli mlx config compare` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [config](./mlx-config.md) › **compare**_ + +## NAME + +nico-admin-cli-mlx-config-compare - Compare device configuration against +expected values + +## SYNOPSIS + +**nico-admin-cli mlx config compare** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*DEVICE_ID*\> \<*REGISTRY_NAME*\> \[*ASSIGNMENTS*\] + +## DESCRIPTION + +Compare device configuration against expected values + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +\<*REGISTRY_NAME*\> + +\[*ASSIGNMENTS*\] + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-query.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-query.md new file mode 100644 index 0000000000..7b13c4a76d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-query.md @@ -0,0 +1,55 @@ +# `nico-admin-cli mlx config query` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [config](./mlx-config.md) › **query**_ + +## NAME + +nico-admin-cli-mlx-config-query - Query device configuration values + +## SYNOPSIS + +**nico-admin-cli mlx config query** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> \<*DEVICE_ID*\> +\<*REGISTRY_NAME*\> \[*VARIABLES*\] + +## DESCRIPTION + +Query device configuration values + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +\<*REGISTRY_NAME*\> +Backing variable registry to query against + +\[*VARIABLES*\] +Variables to query, all if unset. + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-set.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-set.md new file mode 100644 index 0000000000..e92b5572b4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-set.md @@ -0,0 +1,53 @@ +# `nico-admin-cli mlx config set` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [config](./mlx-config.md) › **set**_ + +## NAME + +nico-admin-cli-mlx-config-set - Set device configuration values + +## SYNOPSIS + +**nico-admin-cli mlx config set** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> \<*DEVICE_ID*\> +\<*REGISTRY_NAME*\> \[*ASSIGNMENTS*\] + +## DESCRIPTION + +Set device configuration values + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +\<*REGISTRY_NAME*\> + +\[*ASSIGNMENTS*\] + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-sync.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-sync.md new file mode 100644 index 0000000000..0b64e9c389 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config-sync.md @@ -0,0 +1,54 @@ +# `nico-admin-cli mlx config sync` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [config](./mlx-config.md) › **sync**_ + +## NAME + +nico-admin-cli-mlx-config-sync - Synchronize configuration values to a +device + +## SYNOPSIS + +**nico-admin-cli mlx config sync** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> \<*DEVICE_ID*\> +\<*REGISTRY_NAME*\> \[*ASSIGNMENTS*\] + +## DESCRIPTION + +Synchronize configuration values to a device + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +\<*REGISTRY_NAME*\> + +\[*ASSIGNMENTS*\] + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-config.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config.md new file mode 100644 index 0000000000..43a614e7af --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-config.md @@ -0,0 +1,59 @@ +# `nico-admin-cli mlx config` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › **config**_ + +## NAME + +nico-admin-cli-mlx-config - Config management operations + +## SYNOPSIS + +**nico-admin-cli mlx config** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Config management operations + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli mlx config query 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry +nico-admin-cli mlx config set 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry LINK_TYPE=eth,SRIOV_EN=true +nico-admin-cli mlx config compare 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 my-registry LINK_TYPE=eth +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`query`](./mlx-config-query.md) | Query device configuration values | +| [`set`](./mlx-config-set.md) | Set device configuration values | +| [`sync`](./mlx-config-sync.md) | Synchronize configuration values to a device | +| [`compare`](./mlx-config-compare.md) | Compare device configuration against expected values | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections-disconnect.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections-disconnect.md new file mode 100644 index 0000000000..9c617661e2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections-disconnect.md @@ -0,0 +1,45 @@ +# `nico-admin-cli mlx connections disconnect` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [connections](./mlx-connections.md) › **disconnect**_ + +## NAME + +nico-admin-cli-mlx-connections-disconnect - Disconnect a scout stream +connection + +## SYNOPSIS + +**nico-admin-cli mlx connections disconnect** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Disconnect a scout stream connection + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections-show.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections-show.md new file mode 100644 index 0000000000..775cfce983 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections-show.md @@ -0,0 +1,43 @@ +# `nico-admin-cli mlx connections show` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [connections](./mlx-connections.md) › **show**_ + +## NAME + +nico-admin-cli-mlx-connections-show - Show all active scout stream +connections + +## SYNOPSIS + +**nico-admin-cli mlx connections show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show all active scout stream connections + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections.md new file mode 100644 index 0000000000..e2209fd333 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-connections.md @@ -0,0 +1,57 @@ +# `nico-admin-cli mlx connections` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › **connections**_ + +## NAME + +nico-admin-cli-mlx-connections - scout stream agent connection +management + +## SYNOPSIS + +**nico-admin-cli mlx connections** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +scout stream agent connection management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli mlx connections show +nico-admin-cli mlx connections disconnect 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./mlx-connections-show.md) | Show all active scout stream connections | +| [`disconnect`](./mlx-connections-disconnect.md) | Disconnect a scout stream connection | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-info-device.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-info-device.md new file mode 100644 index 0000000000..a3722f7c10 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-info-device.md @@ -0,0 +1,49 @@ +# `nico-admin-cli mlx info device` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [info](./mlx-info.md) › **device**_ + +## NAME + +nico-admin-cli-mlx-info-device - Get MlxDeviceInfo for a device on a +machine + +## SYNOPSIS + +**nico-admin-cli mlx info device** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> \<*DEVICE_ID*\> + +## DESCRIPTION + +Get MlxDeviceInfo for a device on a machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-info-machine.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-info-machine.md new file mode 100644 index 0000000000..1af4ea6e2b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-info-machine.md @@ -0,0 +1,45 @@ +# `nico-admin-cli mlx info machine` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [info](./mlx-info.md) › **machine**_ + +## NAME + +nico-admin-cli-mlx-info-machine - Get an MlxDeviceReport for a machine + +## SYNOPSIS + +**nico-admin-cli mlx info machine** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Get an MlxDeviceReport for a machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-info.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-info.md new file mode 100644 index 0000000000..775717574d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-info.md @@ -0,0 +1,56 @@ +# `nico-admin-cli mlx info` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › **info**_ + +## NAME + +nico-admin-cli-mlx-info - Device information retrieval + +## SYNOPSIS + +**nico-admin-cli mlx info** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Device information retrieval + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli mlx info device 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 +nico-admin-cli mlx info machine 12345678-1234-5678-90ab-cdef01234567 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`device`](./mlx-info-device.md) | Get MlxDeviceInfo for a device on a machine | +| [`machine`](./mlx-info-machine.md) | Get an MlxDeviceReport for a machine | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-lock.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-lock.md new file mode 100644 index 0000000000..cc4831cda0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-lock.md @@ -0,0 +1,49 @@ +# `nico-admin-cli mlx lockdown lock` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [lockdown](./mlx-lockdown.md) › **lock**_ + +## NAME + +nico-admin-cli-mlx-lockdown-lock - Lock hardware access on a device + +## SYNOPSIS + +**nico-admin-cli mlx lockdown lock** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*DEVICE_ID*\> + +## DESCRIPTION + +Lock hardware access on a device + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-status.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-status.md new file mode 100644 index 0000000000..b786ec77d7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-status.md @@ -0,0 +1,50 @@ +# `nico-admin-cli mlx lockdown status` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [lockdown](./mlx-lockdown.md) › **status**_ + +## NAME + +nico-admin-cli-mlx-lockdown-status - Get the current lock/unlock status +of a device + +## SYNOPSIS + +**nico-admin-cli mlx lockdown status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*DEVICE_ID*\> + +## DESCRIPTION + +Get the current lock/unlock status of a device + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-unlock.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-unlock.md new file mode 100644 index 0000000000..8b898a2498 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown-unlock.md @@ -0,0 +1,49 @@ +# `nico-admin-cli mlx lockdown unlock` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [lockdown](./mlx-lockdown.md) › **unlock**_ + +## NAME + +nico-admin-cli-mlx-lockdown-unlock - Unlock hardware access on a device + +## SYNOPSIS + +**nico-admin-cli mlx lockdown unlock** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*DEVICE_ID*\> + +## DESCRIPTION + +Unlock hardware access on a device + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown.md new file mode 100644 index 0000000000..5cec366c39 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-lockdown.md @@ -0,0 +1,58 @@ +# `nico-admin-cli mlx lockdown` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › **lockdown**_ + +## NAME + +nico-admin-cli-mlx-lockdown - Device lockdown operations + +## SYNOPSIS + +**nico-admin-cli mlx lockdown** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Device lockdown operations + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli mlx lockdown lock 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 +nico-admin-cli mlx lockdown unlock 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 +nico-admin-cli mlx lockdown status 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`lock`](./mlx-lockdown-lock.md) | Lock hardware access on a device | +| [`unlock`](./mlx-lockdown-unlock.md) | Unlock hardware access on a device | +| [`status`](./mlx-lockdown-status.md) | Get the current lock/unlock status of a device | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-compare.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-compare.md new file mode 100644 index 0000000000..dcd12bada6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-compare.md @@ -0,0 +1,53 @@ +# `nico-admin-cli mlx profile compare` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [profile](./mlx-profile.md) › **compare**_ + +## NAME + +nico-admin-cli-mlx-profile-compare - Compare a profile to a device on a +given machine + +## SYNOPSIS + +**nico-admin-cli mlx profile compare** \<**--profile-name**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> \<*DEVICE_ID*\> + +## DESCRIPTION + +Compare a profile to a device on a given machine + +## OPTIONS + +**--profile-name** *\* +Profile name to compare + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-list.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-list.md new file mode 100644 index 0000000000..9ee7115a61 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-list.md @@ -0,0 +1,42 @@ +# `nico-admin-cli mlx profile list` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [profile](./mlx-profile.md) › **list**_ + +## NAME + +nico-admin-cli-mlx-profile-list - List all available profiles + +## SYNOPSIS + +**nico-admin-cli mlx profile list** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +List all available profiles + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-show.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-show.md new file mode 100644 index 0000000000..5cd2851814 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-show.md @@ -0,0 +1,45 @@ +# `nico-admin-cli mlx profile show` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [profile](./mlx-profile.md) › **show**_ + +## NAME + +nico-admin-cli-mlx-profile-show - Show profile details + +## SYNOPSIS + +**nico-admin-cli mlx profile show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*PROFILE_NAME*\> + +## DESCRIPTION + +Show profile details + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*PROFILE_NAME*\> +Profile name to show + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-sync.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-sync.md new file mode 100644 index 0000000000..8dc63f138a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile-sync.md @@ -0,0 +1,53 @@ +# `nico-admin-cli mlx profile sync` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [profile](./mlx-profile.md) › **sync**_ + +## NAME + +nico-admin-cli-mlx-profile-sync - Synchronize a profile to a device on a +given machine + +## SYNOPSIS + +**nico-admin-cli mlx profile sync** \<**--profile-name**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*MACHINE_ID*\> \<*DEVICE_ID*\> + +## DESCRIPTION + +Synchronize a profile to a device on a given machine + +## OPTIONS + +**--profile-name** *\* +Profile name to sync + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*DEVICE_ID*\> +Device ID is the PCI or mst path on the target machine + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile.md new file mode 100644 index 0000000000..47754c49ac --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-profile.md @@ -0,0 +1,60 @@ +# `nico-admin-cli mlx profile` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › **profile**_ + +## NAME + +nico-admin-cli-mlx-profile - Configuration profile management + +## SYNOPSIS + +**nico-admin-cli mlx profile** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Configuration profile management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli mlx profile list +nico-admin-cli mlx profile show my-profile +nico-admin-cli mlx profile sync 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 --profile-name my-profile +nico-admin-cli mlx profile compare 12345678-1234-5678-90ab-cdef01234567 0000:01:00.0 --profile-name my-profile +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`sync`](./mlx-profile-sync.md) | Synchronize a profile to a device on a given machine | +| [`compare`](./mlx-profile-compare.md) | Compare a profile to a device on a given machine | +| [`show`](./mlx-profile-show.md) | Show profile details | +| [`list`](./mlx-profile-list.md) | List all available profiles | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry-list.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry-list.md new file mode 100644 index 0000000000..bfaddc3780 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry-list.md @@ -0,0 +1,45 @@ +# `nico-admin-cli mlx registry list` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [registry](./mlx-registry.md) › **list**_ + +## NAME + +nico-admin-cli-mlx-registry-list - List all available registries + +## SYNOPSIS + +**nico-admin-cli mlx registry list** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +List all available registries + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry-show.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry-show.md new file mode 100644 index 0000000000..ca435a09f0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry-show.md @@ -0,0 +1,49 @@ +# `nico-admin-cli mlx registry show` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › [registry](./mlx-registry.md) › **show**_ + +## NAME + +nico-admin-cli-mlx-registry-show - Show details of a specific registry + +## SYNOPSIS + +**nico-admin-cli mlx registry show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> +\<*REGISTRY_NAME*\> + +## DESCRIPTION + +Show details of a specific registry + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +Carbide Machine ID + +\<*REGISTRY_NAME*\> +Registry name to show + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry.md new file mode 100644 index 0000000000..ec068b0889 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx-registry.md @@ -0,0 +1,56 @@ +# `nico-admin-cli mlx registry` + +_[Hardware commands](../../hardware.md) › [mlx](./mlx.md) › **registry**_ + +## NAME + +nico-admin-cli-mlx-registry - Variable registry operations + +## SYNOPSIS + +**nico-admin-cli mlx registry** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Variable registry operations + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli mlx registry list 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli mlx registry show 12345678-1234-5678-90ab-cdef01234567 my-registry +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`list`](./mlx-registry-list.md) | List all available registries | +| [`show`](./mlx-registry-show.md) | Show details of a specific registry | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/mlx/mlx.md b/docs/manuals/nico-admin-cli/commands/mlx/mlx.md new file mode 100644 index 0000000000..76b64d86cc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/mlx/mlx.md @@ -0,0 +1,53 @@ +# `nico-admin-cli mlx` + +_[Hardware commands](../../hardware.md) › **mlx**_ + +## NAME + +nico-admin-cli-mlx - Mellanox Device Handling + +## SYNOPSIS + +**nico-admin-cli mlx** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Mellanox Device Handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`profile`](./mlx-profile.md) | Configuration profile management | +| [`lockdown`](./mlx-lockdown.md) | Device lockdown operations | +| [`info`](./mlx-info.md) | Device information retrieval | +| [`connections`](./mlx-connections.md) | scout stream agent connection management | +| [`registry`](./mlx-registry.md) | Variable registry operations | +| [`config`](./mlx-config.md) | Config management operations | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-device/network-device-show.md b/docs/manuals/nico-admin-cli/commands/network-device/network-device-show.md new file mode 100644 index 0000000000..0f2b0a9970 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-device/network-device-show.md @@ -0,0 +1,56 @@ +# `nico-admin-cli network-device show` + +_[Network commands](../../network.md) › [network-device](./network-device.md) › **show**_ + +## NAME + +nico-admin-cli-network-device-show - Display network device information + +## SYNOPSIS + +**nico-admin-cli network-device show** \[**-a**\|**--all**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display network device information + +## OPTIONS + +**-a**, **--all** +Show all network devices (DEPRECATED) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] \[default: \] +Show data for the given network device (e.g. \`mac=\\`), leave +empty for all (default) + +## Examples + +```sh +nico-admin-cli network-device show +nico-admin-cli network-device show mac=00:11:22:33:44:55 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-device/network-device.md b/docs/manuals/nico-admin-cli/commands/network-device/network-device.md new file mode 100644 index 0000000000..7e7e591c0f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-device/network-device.md @@ -0,0 +1,48 @@ +# `nico-admin-cli network-device` + +_[Network commands](../../network.md) › **network-device**_ + +## NAME + +nico-admin-cli-network-device - Network Devices handling + +## SYNOPSIS + +**nico-admin-cli network-device** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Network Devices handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./network-device-show.md) | Display network device information | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-attach.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-attach.md new file mode 100644 index 0000000000..a6b3fe0b15 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-attach.md @@ -0,0 +1,61 @@ +# `nico-admin-cli network-security-group attach` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **attach**_ + +## NAME + +nico-admin-cli-network-security-group-attach - Attach a network security +group to a VPC or instance + +## SYNOPSIS + +**nico-admin-cli network-security-group attach** \<**-n**\|**--id**\> +\[**-v**\|**--vpc-id**\] \[**-i**\|**--instance-id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Attach a network security group to a VPC or instance + +## OPTIONS + +**-n**, **--id** *\* +Network security group ID to attach + +**-v**, **--vpc-id** *\* +Optional, VPC ID that should have the network security group applied + +**-i**, **--instance-id** *\* +Optional, Instance ID that should have the network security group +applied + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-security-group attach --id 12345678-1234-5678-90ab-cdef01234567 --vpc-id abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli network-security-group attach --id 12345678-1234-5678-90ab-cdef01234567 --instance-id abcdef01-2345-6789-abcd-ef0123456789 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-create.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-create.md new file mode 100644 index 0000000000..e3d0836142 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-create.md @@ -0,0 +1,76 @@ +# `nico-admin-cli network-security-group create` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **create**_ + +## NAME + +nico-admin-cli-network-security-group-create - Create a network security +group + +## SYNOPSIS + +**nico-admin-cli network-security-group create** \[**-i**\|**--id**\] +\<**-t**\|**--tenant-organization-id**\> \[**-n**\|**--name**\] +\[**-d**\|**--description**\] \[**-l**\|**--labels**\] +\[**-s**\|**--stateful-egress**\] \[**-r**\|**--rules**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create a network security group + +## OPTIONS + +**-i**, **--id** *\* +Optional, unique ID to use when creating the network security group + +**-t**, **--tenant-organization-id** *\* +Tenant organization ID of the network security group + +**-n**, **--name** *\* +Name of the network security group + +**-d**, **--description** *\* +Description of the network security group + +**-l**, **--labels** *\* +JSON map of simple key:value pairs to be applied as labels to the +network security group + +**-s**, **--stateful-egress** +Optional, whether egress rules are stateful + +**-r**, **--rules** *\* +Optional, JSON array containing a defined set of network security group +rules + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-security-group create --tenant-organization-id fds34511233a --name web-tier +nico-admin-cli network-security-group create --tenant-organization-id fds34511233a --name web-tier --stateful-egress --labels '{"env":"prod"}' +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-delete.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-delete.md new file mode 100644 index 0000000000..e633cc2961 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-delete.md @@ -0,0 +1,56 @@ +# `nico-admin-cli network-security-group delete` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **delete**_ + +## NAME + +nico-admin-cli-network-security-group-delete - Delete a network security +group + +## SYNOPSIS + +**nico-admin-cli network-security-group delete** \<**-i**\|**--id**\> +\<**-t**\|**--tenant-organization-id**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete a network security group + +## OPTIONS + +**-i**, **--id** *\* +Network security group ID to delete + +**-t**, **--tenant-organization-id** *\* +Tenant organization ID of the network security group + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-security-group delete --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-detach.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-detach.md new file mode 100644 index 0000000000..ba8ef7e774 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-detach.md @@ -0,0 +1,58 @@ +# `nico-admin-cli network-security-group detach` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **detach**_ + +## NAME + +nico-admin-cli-network-security-group-detach - Remove a network security +group from a VPC or instance + +## SYNOPSIS + +**nico-admin-cli network-security-group detach** +\[**-v**\|**--vpc-id**\] \[**-i**\|**--instance-id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Remove a network security group from a VPC or instance + +## OPTIONS + +**-v**, **--vpc-id** *\* +Optional, VPC ID that should have the network security group removed + +**-i**, **--instance-id** *\* +Optional, Instance ID that should have the network security group +removed + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-security-group detach --vpc-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli network-security-group detach --instance-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-show-attachments.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-show-attachments.md new file mode 100644 index 0000000000..58228d6808 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-show-attachments.md @@ -0,0 +1,58 @@ +# `nico-admin-cli network-security-group show-attachments` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **show-attachments**_ + +## NAME + +nico-admin-cli-network-security-group-show-attachments - Show info about +the objects referencing a network security group + +## SYNOPSIS + +**nico-admin-cli network-security-group show-attachments** +\<**-i**\|**--id**\> \[**-a**\|**--include-indirect**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show info about the objects referencing a network security group + +## OPTIONS + +**-i**, **--id** *\* +network security group ID to query + +**-a**, **--include-indirect** +include indirect relationships (objects that are inheriting the NSG from +a parent object) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-security-group show-attachments --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli network-security-group show-attachments --id 12345678-1234-5678-90ab-cdef01234567 --include-indirect +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-show.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-show.md new file mode 100644 index 0000000000..9b4aee17a0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-show.md @@ -0,0 +1,53 @@ +# `nico-admin-cli network-security-group show` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **show**_ + +## NAME + +nico-admin-cli-network-security-group-show - Show one or more network +security groups + +## SYNOPSIS + +**nico-admin-cli network-security-group show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Show one or more network security groups + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +Optional, network security group ID to restrict the search + +## Examples + +```sh +nico-admin-cli network-security-group show +nico-admin-cli network-security-group show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-update.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-update.md new file mode 100644 index 0000000000..c710e46b5f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group-update.md @@ -0,0 +1,89 @@ +# `nico-admin-cli network-security-group update` + +_[Network commands](../../network.md) › [network-security-group](./network-security-group.md) › **update**_ + +## NAME + +nico-admin-cli-network-security-group-update - Update a network security +group + +## SYNOPSIS + +**nico-admin-cli network-security-group update** \<**-i**\|**--id**\> +\<**-t**\|**--tenant-organization-id**\> \[**-n**\|**--name**\] +\[**-d**\|**--description**\] \[**-l**\|**--labels**\] +\[**-s**\|**--stateful-egress**\] \[**-r**\|**--rules**\] +\[**-v**\|**--version**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update a network security group + +## OPTIONS + +**-i**, **--id** *\* +Network security group ID to update + +**-t**, **--tenant-organization-id** *\* +Tenant organization ID of the network security group + +**-n**, **--name** *\* +Name of the network security group + +**-d**, **--description** *\* +Description of the network security group + +**-l**, **--labels** *\* +JSON map of simple key:value pairs to be applied as labels to the +network security group - will COMPLETELY overwrite any existing labels + +**-s**, **--stateful-egress** *\* +Optional, whether egress rules are stateful\ + +\ +*Possible values:* + +- true + +- false + +**-r**, **--rules** *\* +Optional, JSON array containing a defined set of network security group +rules - will COMPLETELY overwrite any existing rules + +**-v**, **--version** *\* +Optional, version to use for comparison when performing the update, +which will be rejected if the actual version of the record does not +match the value of this parameter + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-security-group update --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a --name web-tier +nico-admin-cli network-security-group update --id 12345678-1234-5678-90ab-cdef01234567 --tenant-organization-id fds34511233a --rules '[...]' +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group.md b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group.md new file mode 100644 index 0000000000..b7088575f2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-security-group/network-security-group.md @@ -0,0 +1,55 @@ +# `nico-admin-cli network-security-group` + +_[Network commands](../../network.md) › **network-security-group**_ + +## NAME + +nico-admin-cli-network-security-group - Network security group +management + +## SYNOPSIS + +**nico-admin-cli network-security-group** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Network security group management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./network-security-group-create.md) | Create a network security group | +| [`show`](./network-security-group-show.md) | Show one or more network security groups | +| [`delete`](./network-security-group-delete.md) | Delete a network security group | +| [`update`](./network-security-group-update.md) | Update a network security group | +| [`show-attachments`](./network-security-group-show-attachments.md) | Show info about the objects referencing a network security group | +| [`attach`](./network-security-group-attach.md) | Attach a network security group to a VPC or instance | +| [`detach`](./network-security-group-detach.md) | Remove a network security group from a VPC or instance | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-segment/network-segment-delete.md b/docs/manuals/nico-admin-cli/commands/network-segment/network-segment-delete.md new file mode 100644 index 0000000000..7f73103bc9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-segment/network-segment-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli network-segment delete` + +_[Network commands](../../network.md) › [network-segment](./network-segment.md) › **delete**_ + +## NAME + +nico-admin-cli-network-segment-delete - Delete Network Segment + +## SYNOPSIS + +**nico-admin-cli network-segment delete** \<**--id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete Network Segment + +## OPTIONS + +**--id** *\* +Id of the network segment + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli network-segment delete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-segment/network-segment-show.md b/docs/manuals/nico-admin-cli/commands/network-segment/network-segment-show.md new file mode 100644 index 0000000000..9ce3bf2b84 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-segment/network-segment-show.md @@ -0,0 +1,61 @@ +# `nico-admin-cli network-segment show` + +_[Network commands](../../network.md) › [network-segment](./network-segment.md) › **show**_ + +## NAME + +nico-admin-cli-network-segment-show - Display Network Segment +information + +## SYNOPSIS + +**nico-admin-cli network-segment show** \[**-t**\|**--tenant-org-id**\] +\[**-n**\|**--name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*NETWORK*\] + +## DESCRIPTION + +Display Network Segment information + +## OPTIONS + +**-t**, **--tenant-org-id** *\* +The Tenant Org ID to query + +**-n**, **--name** *\* +The VPC name to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*NETWORK*\] +The network segment to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli network-segment show +nico-admin-cli network-segment show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli network-segment show --tenant-org-id fds34511233a +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/network-segment/network-segment.md b/docs/manuals/nico-admin-cli/commands/network-segment/network-segment.md new file mode 100644 index 0000000000..5a9f572c38 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/network-segment/network-segment.md @@ -0,0 +1,49 @@ +# `nico-admin-cli network-segment` + +_[Network commands](../../network.md) › **network-segment**_ + +## NAME + +nico-admin-cli-network-segment - Network Segment related handling + +## SYNOPSIS + +**nico-admin-cli network-segment** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Network Segment related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./network-segment-show.md) | Display Network Segment information | +| [`delete`](./network-segment-delete.md) | Delete Network Segment | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-print-empty-template.md b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-print-empty-template.md new file mode 100644 index 0000000000..b9eaf589f2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-print-empty-template.md @@ -0,0 +1,43 @@ +# `nico-admin-cli nvl-domain health-report print-empty-template` + +_[Network commands](../../network.md) › [nvl-domain](./nvl-domain.md) › [health-report](./nvl-domain-health-report.md) › **print-empty-template**_ + +## NAME + +nico-admin-cli-nvl-domain-health-report-print-empty-template - Print an +empty health report template + +## SYNOPSIS + +**nico-admin-cli nvl-domain health-report print-empty-template** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print an empty health report template + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-remove.md b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-remove.md new file mode 100644 index 0000000000..e228b3a6c6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-remove.md @@ -0,0 +1,48 @@ +# `nico-admin-cli nvl-domain health-report remove` + +_[Network commands](../../network.md) › [nvl-domain](./nvl-domain.md) › [health-report](./nvl-domain-health-report.md) › **remove**_ + +## NAME + +nico-admin-cli-nvl-domain-health-report-remove - Remove a health report +source from an NVLink domain + +## SYNOPSIS + +**nico-admin-cli nvl-domain health-report remove** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*DOMAIN_ID*\> +\<*REPORT_SOURCE*\> + +## DESCRIPTION + +Remove a health report source from an NVLink domain + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*DOMAIN_ID*\> + +\<*REPORT_SOURCE*\> + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-show.md b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-show.md new file mode 100644 index 0000000000..6832dc80b8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report-show.md @@ -0,0 +1,45 @@ +# `nico-admin-cli nvl-domain health-report show` + +_[Network commands](../../network.md) › [nvl-domain](./nvl-domain.md) › [health-report](./nvl-domain-health-report.md) › **show**_ + +## NAME + +nico-admin-cli-nvl-domain-health-report-show - List health report +sources for an NVLink domain + +## SYNOPSIS + +**nico-admin-cli nvl-domain health-report show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*DOMAIN_ID*\> + +## DESCRIPTION + +List health report sources for an NVLink domain + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*DOMAIN_ID*\> + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report.md b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report.md new file mode 100644 index 0000000000..a0df6cadb8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain-health-report.md @@ -0,0 +1,59 @@ +# `nico-admin-cli nvl-domain health-report` + +_[Network commands](../../network.md) › [nvl-domain](./nvl-domain.md) › **health-report**_ + +## NAME + +nico-admin-cli-nvl-domain-health-report - Manage NVLink domain health +report sources + +## SYNOPSIS + +**nico-admin-cli nvl-domain health-report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage NVLink domain health report sources + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli nvl-domain health-report show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli nvl-domain health-report remove 12345678-1234-5678-90ab-cdef01234567 internal-maintenance +nico-admin-cli nvl-domain health-report print-empty-template +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./nvl-domain-health-report-show.md) | List health report sources for an NVLink domain | +| [`print-empty-template`](./nvl-domain-health-report-print-empty-template.md) | Print an empty health report template | +| [`remove`](./nvl-domain-health-report-remove.md) | Remove a health report source from an NVLink domain | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain.md b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain.md new file mode 100644 index 0000000000..95270cee26 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-domain/nvl-domain.md @@ -0,0 +1,48 @@ +# `nico-admin-cli nvl-domain` + +_[Network commands](../../network.md) › **nvl-domain**_ + +## NAME + +nico-admin-cli-nvl-domain - NVLink domain related handling + +## SYNOPSIS + +**nico-admin-cli nvl-domain** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +NVLink domain related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`health-report`](./nvl-domain-health-report.md) | Manage NVLink domain health report sources | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-partition/nvl-partition-show.md b/docs/manuals/nico-admin-cli/commands/nvl-partition/nvl-partition-show.md new file mode 100644 index 0000000000..150cb1e1f8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-partition/nvl-partition-show.md @@ -0,0 +1,61 @@ +# `nico-admin-cli nvl-partition show` + +_[Hardware commands](../../hardware.md) › [nvl-partition](./nvl-partition.md) › **show**_ + +## NAME + +nico-admin-cli-nvl-partition-show - Display NvLink partition information + +## SYNOPSIS + +**nico-admin-cli nvl-partition show** \[**-t**\|**--tenant-org-id**\] +\[**-n**\|**--name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display NvLink partition information + +## OPTIONS + +**-t**, **--tenant-org-id** *\* +Optional, Tenant Organization ID to search for + +**-n**, **--name** *\* +Optional, NvLink Partition Name to search for + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] \[default: \] +Optional, NvLink Partition ID to search for + +## Examples + +```sh +nico-admin-cli nvl-partition show +nico-admin-cli nvl-partition show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli nvl-partition show --tenant-org-id fds34511233a +nico-admin-cli nvl-partition show --name my-partition +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvl-partition/nvl-partition.md b/docs/manuals/nico-admin-cli/commands/nvl-partition/nvl-partition.md new file mode 100644 index 0000000000..55accf2c29 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvl-partition/nvl-partition.md @@ -0,0 +1,48 @@ +# `nico-admin-cli nvl-partition` + +_[Hardware commands](../../hardware.md) › **nvl-partition**_ + +## NAME + +nico-admin-cli-nvl-partition - NvLink Partition related handling + +## SYNOPSIS + +**nico-admin-cli nvl-partition** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +NvLink Partition related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./nvl-partition-show.md) | Display NvLink partition information | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-create.md b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-create.md new file mode 100644 index 0000000000..ec69050822 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-create.md @@ -0,0 +1,54 @@ +# `nico-admin-cli nvlink-nmxc-endpoints create` + +_[Hardware commands](../../hardware.md) › [nvlink-nmxc-endpoints](./nvlink-nmxc-endpoints.md) › **create**_ + +## NAME + +nico-admin-cli-nvlink-nmxc-endpoints-create - Insert a mapping for a +chassis serial + +## SYNOPSIS + +**nico-admin-cli nvlink-nmxc-endpoints create** \<**--chassis-serial**\> +\<**--endpoint**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Insert a mapping for a chassis serial + +## OPTIONS + +**--chassis-serial** *\* +**--endpoint** *\* +NMX-C gRPC base URL (e.g. https://host:50051) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli nvlink-nmxc-endpoints create --chassis-serial 1234567890123 --endpoint https://192.0.2.10:50051 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-delete.md b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-delete.md new file mode 100644 index 0000000000..e058fb120a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-delete.md @@ -0,0 +1,50 @@ +# `nico-admin-cli nvlink-nmxc-endpoints delete` + +_[Hardware commands](../../hardware.md) › [nvlink-nmxc-endpoints](./nvlink-nmxc-endpoints.md) › **delete**_ + +## NAME + +nico-admin-cli-nvlink-nmxc-endpoints-delete - Remove a mapping by +chassis serial + +## SYNOPSIS + +**nico-admin-cli nvlink-nmxc-endpoints delete** \<**--chassis-serial**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Remove a mapping by chassis serial + +## OPTIONS + +**--chassis-serial** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli nvlink-nmxc-endpoints delete --chassis-serial 1234567890123 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-show.md b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-show.md new file mode 100644 index 0000000000..dfd27b445e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-show.md @@ -0,0 +1,53 @@ +# `nico-admin-cli nvlink-nmxc-endpoints show` + +_[Hardware commands](../../hardware.md) › [nvlink-nmxc-endpoints](./nvlink-nmxc-endpoints.md) › **show**_ + +## NAME + +nico-admin-cli-nvlink-nmxc-endpoints-show - List chassis serial → NMX-C +endpoint mappings (optionally one serial) + +## SYNOPSIS + +**nico-admin-cli nvlink-nmxc-endpoints show** \[**--chassis-serial**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List chassis serial → NMX-C endpoint mappings (optionally one serial) + +## OPTIONS + +**--chassis-serial** *\* +If set, show only this chassis serial + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli nvlink-nmxc-endpoints show +nico-admin-cli nvlink-nmxc-endpoints show --chassis-serial 1234567890123 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-update.md b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-update.md new file mode 100644 index 0000000000..0d22343920 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints-update.md @@ -0,0 +1,52 @@ +# `nico-admin-cli nvlink-nmxc-endpoints update` + +_[Hardware commands](../../hardware.md) › [nvlink-nmxc-endpoints](./nvlink-nmxc-endpoints.md) › **update**_ + +## NAME + +nico-admin-cli-nvlink-nmxc-endpoints-update - Change the endpoint URL +for a chassis serial + +## SYNOPSIS + +**nico-admin-cli nvlink-nmxc-endpoints update** \<**--chassis-serial**\> +\<**--endpoint**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Change the endpoint URL for a chassis serial + +## OPTIONS + +**--chassis-serial** *\* +**--endpoint** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli nvlink-nmxc-endpoints update --chassis-serial 1234567890123 --endpoint https://192.0.2.20:50051 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints.md b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints.md new file mode 100644 index 0000000000..4fdd216946 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints.md @@ -0,0 +1,52 @@ +# `nico-admin-cli nvlink-nmxc-endpoints` + +_[Hardware commands](../../hardware.md) › **nvlink-nmxc-endpoints**_ + +## NAME + +nico-admin-cli-nvlink-nmxc-endpoints - Rack chassis serial → NMX-C +endpoint mappings + +## SYNOPSIS + +**nico-admin-cli nvlink-nmxc-endpoints** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Rack chassis serial → NMX-C endpoint mappings + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./nvlink-nmxc-endpoints-show.md) | List chassis serial → NMX-C endpoint mappings (optionally one serial) | +| [`create`](./nvlink-nmxc-endpoints-create.md) | Insert a mapping for a chassis serial | +| [`update`](./nvlink-nmxc-endpoints-update.md) | Change the endpoint URL for a chassis serial | +| [`delete`](./nvlink-nmxc-endpoints-delete.md) | Remove a mapping by chassis serial | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-create.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-create.md new file mode 100644 index 0000000000..27aecdb38e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-create.md @@ -0,0 +1,94 @@ +# `nico-admin-cli operating-system create` + +_[Tenant commands](../../tenant.md) › [operating-system](./operating-system.md) › **create**_ + +## NAME + +nico-admin-cli-operating-system-create - Create a new operating system +definition. + +## SYNOPSIS + +**nico-admin-cli operating-system create** \<**-n**\|**--name**\> +\<**-o**\|**--org**\> \[**--id**\] \[**-d**\|**--description**\] +\[**--is-active**\] \[**--allow-override**\] +\[**--phone-home-enabled**\] \[**--user-data**\] \[**--ipxe-script**\] +\[**--ipxe-template-id**\] \[**--param**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create a new operating system definition. + +## OPTIONS + +**-n**, **--name** *\* +Name of the operating system definition. + +**-o**, **--org** *\* +Organization identifier for this OS definition. + +**--id** *\* +Optional UUID for the new OS definition (default: server-generated). + +**-d**, **--description** *\* +Optional human-readable description. + +**--is-active** *\* +Whether this OS definition is active (default: true).\ + +\ +*Possible values:* + +- true + +- false + +**--allow-override** +Allow users to override OS parameters. + +**--phone-home-enabled** +Enable phone-home on first boot. + +**--user-data** *\* +Optional cloud-init / user-data script. + +**--ipxe-script** *\* +Raw iPXE boot script (mutually exclusive with --ipxe-template-id). + +**--ipxe-template-id** *\* +ID of the iPXE template to use (mutually exclusive with --ipxe-script). + +**--param** *\* +iPXE parameter in KEY=VALUE format. May be repeated. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli operating-system create --name ubuntu-22.04 --org fds34511233a +nico-admin-cli operating-system create --name ubuntu-22.04 --org fds34511233a --description "Ubuntu 22.04 base" --is-active false --allow-override +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-delete.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-delete.md new file mode 100644 index 0000000000..94d86e1345 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-delete.md @@ -0,0 +1,52 @@ +# `nico-admin-cli operating-system delete` + +_[Tenant commands](../../tenant.md) › [operating-system](./operating-system.md) › **delete**_ + +## NAME + +nico-admin-cli-operating-system-delete - Delete an operating system +definition. + +## SYNOPSIS + +**nico-admin-cli operating-system delete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*ID*\> + +## DESCRIPTION + +Delete an operating system definition. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +UUID of the operating system definition to delete. + +## Examples + +```sh +nico-admin-cli operating-system delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-get-artifacts.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-get-artifacts.md new file mode 100644 index 0000000000..fa9b9d3d58 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-get-artifacts.md @@ -0,0 +1,52 @@ +# `nico-admin-cli operating-system get-artifacts` + +_[Tenant commands](../../tenant.md) › [operating-system](./operating-system.md) › **get-artifacts**_ + +## NAME + +nico-admin-cli-operating-system-get-artifacts - Get the artifact list +for an OS definition. + +## SYNOPSIS + +**nico-admin-cli operating-system get-artifacts** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*ID*\> + +## DESCRIPTION + +Get the artifact list for an OS definition. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +UUID of the operating system definition. + +## Examples + +```sh +nico-admin-cli operating-system get-artifacts 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-set-cached-url.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-set-cached-url.md new file mode 100644 index 0000000000..7c5d146495 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-set-cached-url.md @@ -0,0 +1,57 @@ +# `nico-admin-cli operating-system set-cached-url` + +_[Tenant commands](../../tenant.md) › [operating-system](./operating-system.md) › **set-cached-url**_ + +## NAME + +nico-admin-cli-operating-system-set-cached-url - Set or clear cached_url +on OS artifacts. + +## SYNOPSIS + +**nico-admin-cli operating-system set-cached-url** \<**--set**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*ID*\> + +## DESCRIPTION + +Set or clear cached_url on OS artifacts. + +## OPTIONS + +**--set** *\* +Set cached_url for an artifact. Use NAME=URL to set, NAME= to clear. May +be repeated. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +UUID of the operating system definition. + +## Examples + +```sh +nico-admin-cli operating-system set-cached-url 12345678-1234-5678-90ab-cdef01234567 --set kernel=https://cache.example.com/vmlinuz +nico-admin-cli operating-system set-cached-url 12345678-1234-5678-90ab-cdef01234567 --set kernel= +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-show.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-show.md new file mode 100644 index 0000000000..7e66fcff15 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-show.md @@ -0,0 +1,57 @@ +# `nico-admin-cli operating-system show` + +_[Tenant commands](../../tenant.md) › [operating-system](./operating-system.md) › **show**_ + +## NAME + +nico-admin-cli-operating-system-show - Show operating system definitions +(all, or one by ID). + +## SYNOPSIS + +**nico-admin-cli operating-system show** \[**--org**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Show operating system definitions (all, or one by ID). + +## OPTIONS + +**--org** *\* +Filter by organization identifier (when listing). + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +Operating system definition ID; omit to list all. + +## Examples + +```sh +nico-admin-cli operating-system show +nico-admin-cli operating-system show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli operating-system show --org fds34511233a +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-update.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-update.md new file mode 100644 index 0000000000..855db6a32e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system-update.md @@ -0,0 +1,107 @@ +# `nico-admin-cli operating-system update` + +_[Tenant commands](../../tenant.md) › [operating-system](./operating-system.md) › **update**_ + +## NAME + +nico-admin-cli-operating-system-update - Update an existing operating +system definition. + +## SYNOPSIS + +**nico-admin-cli operating-system update** \[**-n**\|**--name**\] +\[**-d**\|**--description**\] \[**--is-active**\] +\[**--allow-override**\] \[**--phone-home-enabled**\] +\[**--user-data**\] \[**--ipxe-script**\] \[**--ipxe-template-id**\] +\[**--param**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*ID*\> + +## DESCRIPTION + +Update an existing operating system definition. + +## OPTIONS + +**-n**, **--name** *\* +New name for the operating system definition. + +**-d**, **--description** *\* +New description. + +**--is-active** *\* +Set whether this OS definition is active.\ + +\ +*Possible values:* + +- true + +- false + +**--allow-override** *\* +Set whether users can override OS parameters.\ + +\ +*Possible values:* + +- true + +- false + +**--phone-home-enabled** *\* +Set whether phone-home on first boot is enabled.\ + +\ +*Possible values:* + +- true + +- false + +**--user-data** *\* +Update the cloud-init / user-data script. + +**--ipxe-script** *\* +Update the raw iPXE boot script. + +**--ipxe-template-id** *\* +Update the iPXE template ID. + +**--param** \[*\...*\] +Replace all iPXE parameters with these KEY=VALUE pairs. May be repeated. +Pass without values to clear. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +UUID of the operating system definition to update. + +## Examples + +```sh +nico-admin-cli operating-system update 12345678-1234-5678-90ab-cdef01234567 --name ubuntu-22.04 --description "Ubuntu 22.04 base" +nico-admin-cli operating-system update 12345678-1234-5678-90ab-cdef01234567 --is-active false +nico-admin-cli operating-system update 12345678-1234-5678-90ab-cdef01234567 --ipxe-script "#!ipxe …" +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/operating-system/operating-system.md b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system.md new file mode 100644 index 0000000000..20a5e93335 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/operating-system/operating-system.md @@ -0,0 +1,53 @@ +# `nico-admin-cli operating-system` + +_[Tenant commands](../../tenant.md) › **operating-system**_ + +## NAME + +nico-admin-cli-operating-system - Operating system definition management + +## SYNOPSIS + +**nico-admin-cli operating-system** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Operating system definition management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./operating-system-show.md) | Show operating system definitions (all, or one by ID). | +| [`create`](./operating-system-create.md) | Create a new operating system definition. | +| [`update`](./operating-system-update.md) | Update an existing operating system definition. | +| [`delete`](./operating-system-delete.md) | Delete an operating system definition. | +| [`get-artifacts`](./operating-system-get-artifacts.md) | Get the artifact list for an OS definition. | +| [`set-cached-url`](./operating-system-set-cached-url.md) | Set or clear cached_url on OS artifacts. | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/os-image/os-image-create.md b/docs/manuals/nico-admin-cli/commands/os-image/os-image-create.md new file mode 100644 index 0000000000..499e90541c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/os-image/os-image-create.md @@ -0,0 +1,109 @@ +# `nico-admin-cli os-image create` + +_[Tenant commands](../../tenant.md) › [os-image](./os-image.md) › **create**_ + +## NAME + +nico-admin-cli-os-image-create - Create an OS image entry in the OS +catalog for a tenant. + +## SYNOPSIS + +**nico-admin-cli os-image create** \<**-i**\|**--id**\> +\<**-u**\|**--url**\> \<**-m**\|**--digest**\> +\<**-t**\|**--tenant-org-id**\> \[**-v**\|**--create-volume**\] +\[**-s**\|**--capacity**\] \[**-n**\|**--name**\] +\[**-d**\|**--description**\] \[**-y**\|**--auth-type**\] +\[**-p**\|**--auth-token**\] \[**-f**\|**--rootfs-id**\] +\[**-l**\|**--rootfs-label**\] \[**-b**\|**--boot-disk**\] +\[**--bootfs-id**\] \[**--extended**\] \[**--efifs-id**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create an OS image entry in the OS catalog for a tenant. + +## OPTIONS + +**-i**, **--id** *\* +uuid of the OS image to create. + +**-u**, **--url** *\* +url of the OS image qcow file. + +**-m**, **--digest** *\* +Digest of the OS image file, typically a SHA-256. + +**-t**, **--tenant-org-id** *\* +Tenant organization identifier for the OS catalog to create this in. + +**-v**, **--create-volume** *\* +Create a source volume for block storage use.\ + +\ +*Possible values:* + +- true + +- false + +**-s**, **--capacity** *\* +Size of the OS image source volume to create. + +**-n**, **--name** *\* +Name of the OS image entry. + +**-d**, **--description** *\* +Description of the OS image entry. + +**-y**, **--auth-type** *\* +Authentication type, usually Bearer. + +**-p**, **--auth-token** *\* +Authentication token, usually in base64. + +**-f**, **--rootfs-id** *\* +uuid of the root filesystem of the OS image. + +**-l**, **--rootfs-label** *\* +Label of the root filesystem of the OS image. + +**-b**, **--boot-disk** *\* +Boot device path if using local disk. + +**--bootfs-id** *\* +UUID of the image boot filesystem (/boot) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--efifs-id** *\* +UUID of the image EFI filesystem (/boot/efi) + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli os-image create --id 12345678-1234-5678-90ab-cdef01234567 --url https://images.example.com/ubuntu.qcow2 --digest sha256:abcd… --tenant-org-id fds34511233a +nico-admin-cli os-image create --id 12345678-1234-5678-90ab-cdef01234567 --url https://images.example.com/ubuntu.qcow2 --digest sha256:abcd… --tenant-org-id fds34511233a --name ubuntu-22.04 --description "Ubuntu 22.04 base" --auth-type Bearer --auth-token +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/os-image/os-image-delete.md b/docs/manuals/nico-admin-cli/commands/os-image/os-image-delete.md new file mode 100644 index 0000000000..ee1b0cd9bb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/os-image/os-image-delete.md @@ -0,0 +1,56 @@ +# `nico-admin-cli os-image delete` + +_[Tenant commands](../../tenant.md) › [os-image](./os-image.md) › **delete**_ + +## NAME + +nico-admin-cli-os-image-delete - Delete an OS image entry that is not +used on any instances. + +## SYNOPSIS + +**nico-admin-cli os-image delete** \<**-i**\|**--id**\> +\<**-t**\|**--tenant-org-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Delete an OS image entry that is not used on any instances. + +## OPTIONS + +**-i**, **--id** *\* +uuid of the OS image to delete. + +**-t**, **--tenant-org-id** *\* +Tenant organization identifier of OS image to delete. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli os-image delete --id 12345678-1234-5678-90ab-cdef01234567 --tenant-org-id fds34511233a +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/os-image/os-image-show.md b/docs/manuals/nico-admin-cli/commands/os-image/os-image-show.md new file mode 100644 index 0000000000..1570403ecd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/os-image/os-image-show.md @@ -0,0 +1,58 @@ +# `nico-admin-cli os-image show` + +_[Tenant commands](../../tenant.md) › [os-image](./os-image.md) › **show**_ + +## NAME + +nico-admin-cli-os-image-show - Show one or more OS image entries in the +catalog. + +## SYNOPSIS + +**nico-admin-cli os-image show** \[**-i**\|**--id**\] +\[**-t**\|**--tenant-org-id**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Show one or more OS image entries in the catalog. + +## OPTIONS + +**-i**, **--id** *\* +uuid of the OS image to show. + +**-t**, **--tenant-org-id** *\* +Tenant organization identifier to filter OS images listing. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli os-image show --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli os-image show --tenant-org-id fds34511233a +nico-admin-cli os-image show +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/os-image/os-image-update.md b/docs/manuals/nico-admin-cli/commands/os-image/os-image-update.md new file mode 100644 index 0000000000..cf9281f8c6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/os-image/os-image-update.md @@ -0,0 +1,68 @@ +# `nico-admin-cli os-image update` + +_[Tenant commands](../../tenant.md) › [os-image](./os-image.md) › **update**_ + +## NAME + +nico-admin-cli-os-image-update - Update the authentication details or +name and description for an OS image. + +## SYNOPSIS + +**nico-admin-cli os-image update** \<**-i**\|**--id**\> +\[**-n**\|**--name**\] \[**-d**\|**--description**\] +\[**-y**\|**--auth-type**\] \[**-p**\|**--auth-token**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Update the authentication details or name and description for an OS +image. + +## OPTIONS + +**-i**, **--id** *\* +uuid of the OS image to update. + +**-n**, **--name** *\* +Optional, name of the OS image entry. + +**-d**, **--description** *\* +Optional, description of the OS image entry. + +**-y**, **--auth-type** *\* +Optional, Authentication type, usually Bearer. + +**-p**, **--auth-token** *\* +Optional, Authentication token, usually in base64. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli os-image update --id 12345678-1234-5678-90ab-cdef01234567 --name ubuntu-22.04 --description "Ubuntu 22.04 base" +nico-admin-cli os-image update --id 12345678-1234-5678-90ab-cdef01234567 --auth-type Bearer --auth-token +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/os-image/os-image.md b/docs/manuals/nico-admin-cli/commands/os-image/os-image.md new file mode 100644 index 0000000000..9c9e16395d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/os-image/os-image.md @@ -0,0 +1,51 @@ +# `nico-admin-cli os-image` + +_[Tenant commands](../../tenant.md) › **os-image**_ + +## NAME + +nico-admin-cli-os-image - OS catalog management + +## SYNOPSIS + +**nico-admin-cli os-image** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +OS catalog management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./os-image-create.md) | Create an OS image entry in the OS catalog for a tenant. | +| [`show`](./os-image-show.md) | Show one or more OS image entries in the catalog. | +| [`delete`](./os-image-delete.md) | Delete an OS image entry that is not used on any instances. | +| [`update`](./os-image-update.md) | Update the authentication details or name and description for an OS image. | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ping/ping.md b/docs/manuals/nico-admin-cli/commands/ping/ping.md new file mode 100644 index 0000000000..73a8994aec --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ping/ping.md @@ -0,0 +1,55 @@ +# `nico-admin-cli ping` + +_[Admin commands](../../admin.md) › **ping**_ + +## NAME + +nico-admin-cli-ping - Query the Version gRPC endpoint repeatedly +printing how long it took and any failures. + +## SYNOPSIS + +**nico-admin-cli ping** \[**-i**\|**--interval**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Query the Version gRPC endpoint repeatedly printing how long it took and +any failures. + +## OPTIONS + +**-i**, **--interval** *\* \[default: 1.0\] +Wait interval seconds between sending each request. Real number allowed +with dot as a decimal separator. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli ping +nico-admin-cli ping --interval 0.5 +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-delete.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-delete.md new file mode 100644 index 0000000000..6897dd7a6c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli power-shelf delete` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **delete**_ + +## NAME + +nico-admin-cli-power-shelf-delete - Delete a power shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf delete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*POWER_SHELF_ID*\> + +## DESCRIPTION + +Delete a power shelf + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF_ID*\> +Power Shelf ID to delete. + +## Examples + +```sh +nico-admin-cli power-shelf delete 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-force-delete.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-force-delete.md new file mode 100644 index 0000000000..1badfd74e8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-force-delete.md @@ -0,0 +1,57 @@ +# `nico-admin-cli power-shelf force-delete` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **force-delete**_ + +## NAME + +nico-admin-cli-power-shelf-force-delete - Force delete a power shelf and +optionally its interfaces + +## SYNOPSIS + +**nico-admin-cli power-shelf force-delete** +\[**-d**\|**--delete-interfaces**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*POWER_SHELF_ID*\> + +## DESCRIPTION + +Force delete a power shelf and optionally its interfaces + +## OPTIONS + +**-d**, **--delete-interfaces** +Delete machine interfaces associated with this power shelf. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF_ID*\> +Power Shelf ID to force delete. + +## Examples + +```sh +nico-admin-cli power-shelf force-delete 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli power-shelf force-delete 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-add.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-add.md new file mode 100644 index 0000000000..8a7f79f131 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-add.md @@ -0,0 +1,95 @@ +# `nico-admin-cli power-shelf health-report add` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [health-report](./power-shelf-health-report.md) › **add**_ + +## NAME + +nico-admin-cli-power-shelf-health-report-add - Insert a health report +source for a power shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf health-report add** \[**--health-report**\] +\[**--template**\] \[**--message**\] \[**--replace**\] +\[**--print-only**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*POWER_SHELF_ID*\> + +## DESCRIPTION + +Insert a health report source for a power shelf + +## OPTIONS + +**--health-report** *\* +New health report as json + +**--template** *\* +Predefined Template name\ + +\ +*Possible values:* + +- host-update + +- internal-maintenance + +- out-for-repair + +- degraded + +- validation + +- suppress-external-alerting + +- mark-healthy + +- stop-reboot-for-automatic-recovery-from-state-machine + +- tenant-reported-issue + +- request-online-repair + +- request-repair + +**--message** *\* +Message to be filled in template. + +**--replace** +Replace all other health reports with this source + +**--print-only** +Print the template that is going to be send to carbide + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF_ID*\> + +## Examples + +```sh +nico-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance --message "Firmware upgrade in progress" +nico-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 --health-report '{...}' +nico-admin-cli power-shelf health-report add 12345678-1234-5678-90ab-cdef01234567 --template degraded --print-only +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-print-empty-template.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-print-empty-template.md new file mode 100644 index 0000000000..8d89386805 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-print-empty-template.md @@ -0,0 +1,43 @@ +# `nico-admin-cli power-shelf health-report print-empty-template` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [health-report](./power-shelf-health-report.md) › **print-empty-template**_ + +## NAME + +nico-admin-cli-power-shelf-health-report-print-empty-template - Print an +empty health report template + +## SYNOPSIS + +**nico-admin-cli power-shelf health-report print-empty-template** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print an empty health report template + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-remove.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-remove.md new file mode 100644 index 0000000000..f95a69e8ee --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-remove.md @@ -0,0 +1,53 @@ +# `nico-admin-cli power-shelf health-report remove` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [health-report](./power-shelf-health-report.md) › **remove**_ + +## NAME + +nico-admin-cli-power-shelf-health-report-remove - Remove a health report +source from a power shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf health-report remove** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*POWER_SHELF_ID*\> +\<*REPORT_SOURCE*\> + +## DESCRIPTION + +Remove a health report source from a power shelf + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF_ID*\> +\<*REPORT_SOURCE*\> + +## Examples + +```sh +nico-admin-cli power-shelf health-report remove 12345678-1234-5678-90ab-cdef01234567 internal-maintenance +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-show.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-show.md new file mode 100644 index 0000000000..a9c38cac0d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli power-shelf health-report show` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [health-report](./power-shelf-health-report.md) › **show**_ + +## NAME + +nico-admin-cli-power-shelf-health-report-show - List health report +sources for a power shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf health-report show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*POWER_SHELF_ID*\> + +## DESCRIPTION + +List health report sources for a power shelf + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF_ID*\> +Power Shelf ID to show health reports for + +## Examples + +```sh +nico-admin-cli power-shelf health-report show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report.md new file mode 100644 index 0000000000..7fdca7d835 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-health-report.md @@ -0,0 +1,51 @@ +# `nico-admin-cli power-shelf health-report` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **health-report**_ + +## NAME + +nico-admin-cli-power-shelf-health-report - Manage health report sources + +## SYNOPSIS + +**nico-admin-cli power-shelf health-report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage health report sources + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./power-shelf-health-report-show.md) | List health report sources for a power shelf | +| [`add`](./power-shelf-health-report-add.md) | Insert a health report source for a power shelf | +| [`print-empty-template`](./power-shelf-health-report-print-empty-template.md) | Print an empty health report template | +| [`remove`](./power-shelf-health-report-remove.md) | Remove a health report source from a power shelf | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-list.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-list.md new file mode 100644 index 0000000000..61b035a9f5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-list.md @@ -0,0 +1,70 @@ +# `nico-admin-cli power-shelf list` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **list**_ + +## NAME + +nico-admin-cli-power-shelf-list - List all power shelves + +## SYNOPSIS + +**nico-admin-cli power-shelf list** \[**--deleted**\] +\[**--controller-state**\] \[**--bmc-mac**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all power shelves + +## OPTIONS + +**--deleted** *\* \[default: exclude\] +Include deleted power shelves\ + +\ +*Possible values:* + +- exclude: Exclude deleted resources (default behavior) + +- only: Return only deleted resources + +- include: Include both deleted and non-deleted resources + +**--controller-state** *\* +Filter by controller state (e.g. "ready", "initializing", "error") + +**--bmc-mac** *\* +Filter by BMC MAC address + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli power-shelf list +nico-admin-cli power-shelf list --deleted include +nico-admin-cli power-shelf list --controller-state ready +nico-admin-cli power-shelf list --bmc-mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance-power-off.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance-power-off.md new file mode 100644 index 0000000000..d746d78349 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance-power-off.md @@ -0,0 +1,57 @@ +# `nico-admin-cli power-shelf maintenance power-off` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [maintenance](./power-shelf-maintenance.md) › **power-off**_ + +## NAME + +nico-admin-cli-power-shelf-maintenance-power-off - Request the listed +power shelves to power off + +## SYNOPSIS + +**nico-admin-cli power-shelf maintenance power-off** +\<**--power-shelf-id**\> \[**--reference**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Request the listed power shelves to power off + +## OPTIONS + +**--power-shelf-id** *\...* +One or more Power Shelf IDs to drive into maintenance + +**--reference** *\* +URL of reference (ticket, issue, etc) for this maintenance request + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli power-shelf maintenance power-off --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli power-shelf maintenance power-off --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 --reference https://tickets.example.com/PS-42 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance-power-on.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance-power-on.md new file mode 100644 index 0000000000..ef57a99dd9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance-power-on.md @@ -0,0 +1,57 @@ +# `nico-admin-cli power-shelf maintenance power-on` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [maintenance](./power-shelf-maintenance.md) › **power-on**_ + +## NAME + +nico-admin-cli-power-shelf-maintenance-power-on - Request the listed +power shelves to power on + +## SYNOPSIS + +**nico-admin-cli power-shelf maintenance power-on** +\<**--power-shelf-id**\> \[**--reference**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Request the listed power shelves to power on + +## OPTIONS + +**--power-shelf-id** *\...* +One or more Power Shelf IDs to drive into maintenance + +**--reference** *\* +URL of reference (ticket, issue, etc) for this maintenance request + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli power-shelf maintenance power-on --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli power-shelf maintenance power-on --power-shelf-id 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 --reference https://tickets.example.com/PS-42 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance.md new file mode 100644 index 0000000000..1c7ae54782 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-maintenance.md @@ -0,0 +1,50 @@ +# `nico-admin-cli power-shelf maintenance` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **maintenance**_ + +## NAME + +nico-admin-cli-power-shelf-maintenance - Request a power shelf +maintenance operation (PowerOn / PowerOff) + +## SYNOPSIS + +**nico-admin-cli power-shelf maintenance** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Request a power shelf maintenance operation (PowerOn / PowerOff) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`power-on`](./power-shelf-maintenance-power-on.md) | Request the listed power shelves to power on | +| [`power-off`](./power-shelf-maintenance-power-off.md) | Request the listed power shelves to power off | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-add-label.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-add-label.md new file mode 100644 index 0000000000..3acf199bd9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-add-label.md @@ -0,0 +1,60 @@ +# `nico-admin-cli power-shelf metadata add-label` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [metadata](./power-shelf-metadata.md) › **add-label**_ + +## NAME + +nico-admin-cli-power-shelf-metadata-add-label - Adds a label to the +Metadata of a Power Shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf metadata add-label** \<**--key**\> +\[**--value**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*POWER_SHELF*\> + +## DESCRIPTION + +Adds a label to the Metadata of a Power Shelf + +## OPTIONS + +**--key** *\* +The key to add + +**--value** *\* +The optional value to add + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF*\> +The power shelf which should get updated metadata + +## Examples + +```sh +nico-admin-cli power-shelf metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge +nico-admin-cli power-shelf metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key row --value C +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-from-expected-power-shelf.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-from-expected-power-shelf.md new file mode 100644 index 0000000000..34493c5bad --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-from-expected-power-shelf.md @@ -0,0 +1,66 @@ +# `nico-admin-cli power-shelf metadata from-expected-power-shelf` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [metadata](./power-shelf-metadata.md) › **from-expected-power-shelf**_ + +## NAME + +nico-admin-cli-power-shelf-metadata-from-expected-power-shelf - Copy +Power Shelf Metadata from Expected-Power-Shelf to Power Shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf metadata from-expected-power-shelf** +\[**--replace-all**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*POWER_SHELF*\> + +## DESCRIPTION + +Copy Power Shelf Metadata from Expected-Power-Shelf to Power Shelf + +## OPTIONS + +**--replace-all** +Whether to fully replace the Metadata that is currently stored on the +Power Shelf. - If not set, existing Metadata on the Power Shelf will not +be touched by executing the command: - The existing Name will not be +changed if the Name is not equivalent to the Power Shelf ID or Empty. - +The existing Description will not be changed if it is not empty. - +Existing Labels and their values will not be changed. Only labels which +do not exist on the Power Shelf will be added. - If set, the Power +Shelves Metadata will be set to the same values as they would if the +Power Shelf would get freshly ingested. Metadata that is currently set +on the Power Shelf will be overridden. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF*\> +The power shelf which should get updated metadata + +## Examples + +```sh +nico-admin-cli power-shelf metadata from-expected-power-shelf 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli power-shelf metadata from-expected-power-shelf 12345678-1234-5678-90ab-cdef01234567 --replace-all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-remove-labels.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-remove-labels.md new file mode 100644 index 0000000000..b52abd55b1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-remove-labels.md @@ -0,0 +1,56 @@ +# `nico-admin-cli power-shelf metadata remove-labels` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [metadata](./power-shelf-metadata.md) › **remove-labels**_ + +## NAME + +nico-admin-cli-power-shelf-metadata-remove-labels - Removes labels from +the Metadata of a Power Shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf metadata remove-labels** \[**--keys**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*POWER_SHELF*\> + +## DESCRIPTION + +Removes labels from the Metadata of a Power Shelf + +## OPTIONS + +**--keys** *\* +The keys to remove + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF*\> +The power shelf which should get updated metadata + +## Examples + +```sh +nico-admin-cli power-shelf metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 --keys row --keys edge +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-set.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-set.md new file mode 100644 index 0000000000..3e1e841ea3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-set.md @@ -0,0 +1,59 @@ +# `nico-admin-cli power-shelf metadata set` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [metadata](./power-shelf-metadata.md) › **set**_ + +## NAME + +nico-admin-cli-power-shelf-metadata-set - Set the Name or Description of +the Power Shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf metadata set** \[**--name**\] +\[**--description**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*POWER_SHELF*\> + +## DESCRIPTION + +Set the Name or Description of the Power Shelf + +## OPTIONS + +**--name** *\* +The updated name of the Power Shelf + +**--description** *\* +The updated description of the Power Shelf + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF*\> +The power shelf which should get updated metadata + +## Examples + +```sh +nico-admin-cli power-shelf metadata set 12345678-1234-5678-90ab-cdef01234567 --name ps-01 --description "Rack 4 power shelf" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-show.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-show.md new file mode 100644 index 0000000000..a4651d94e9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli power-shelf metadata show` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › [metadata](./power-shelf-metadata.md) › **show**_ + +## NAME + +nico-admin-cli-power-shelf-metadata-show - Show the Metadata of the +Power Shelf + +## SYNOPSIS + +**nico-admin-cli power-shelf metadata show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*POWER_SHELF*\> + +## DESCRIPTION + +Show the Metadata of the Power Shelf + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*POWER_SHELF*\> +The power shelf which should get its metadata displayed + +## Examples + +```sh +nico-admin-cli power-shelf metadata show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata.md new file mode 100644 index 0000000000..4ba91af64c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-metadata.md @@ -0,0 +1,52 @@ +# `nico-admin-cli power-shelf metadata` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **metadata**_ + +## NAME + +nico-admin-cli-power-shelf-metadata - Manage Power Shelf Metadata + +## SYNOPSIS + +**nico-admin-cli power-shelf metadata** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage Power Shelf Metadata + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set`](./power-shelf-metadata-set.md) | Set the Name or Description of the Power Shelf | +| [`show`](./power-shelf-metadata-show.md) | Show the Metadata of the Power Shelf | +| [`add-label`](./power-shelf-metadata-add-label.md) | Adds a label to the Metadata of a Power Shelf | +| [`remove-labels`](./power-shelf-metadata-remove-labels.md) | Removes labels from the Metadata of a Power Shelf | +| [`from-expected-power-shelf`](./power-shelf-metadata-from-expected-power-shelf.md) | Copy Power Shelf Metadata from Expected-Power-Shelf to Power Shelf | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-show.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-show.md new file mode 100644 index 0000000000..78d8dcf911 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli power-shelf show` + +_[Hardware commands](../../hardware.md) › [power-shelf](./power-shelf.md) › **show**_ + +## NAME + +nico-admin-cli-power-shelf-show - Show power shelf information + +## SYNOPSIS + +**nico-admin-cli power-shelf show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*IDENTIFIER*\] + +## DESCRIPTION + +Show power shelf information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IDENTIFIER*\] +Power shelf ID or name to show (leave empty for all) + +## Examples + +```sh +nico-admin-cli power-shelf show +nico-admin-cli power-shelf show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf.md b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf.md new file mode 100644 index 0000000000..b708965d3a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/power-shelf/power-shelf.md @@ -0,0 +1,54 @@ +# `nico-admin-cli power-shelf` + +_[Hardware commands](../../hardware.md) › **power-shelf**_ + +## NAME + +nico-admin-cli-power-shelf - Power Shelf management + +## SYNOPSIS + +**nico-admin-cli power-shelf** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Power Shelf management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./power-shelf-show.md) | Show power shelf information | +| [`list`](./power-shelf-list.md) | List all power shelves | +| [`delete`](./power-shelf-delete.md) | Delete a power shelf | +| [`force-delete`](./power-shelf-force-delete.md) | Force delete a power shelf and optionally its interfaces | +| [`metadata`](./power-shelf-metadata.md) | Manage Power Shelf Metadata | +| [`maintenance`](./power-shelf-maintenance.md) | Request a power shelf maintenance operation (PowerOn / PowerOff) | +| [`health-report`](./power-shelf-health-report.md) | Manage health report sources | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-delete.md b/docs/manuals/nico-admin-cli/commands/rack/rack-delete.md new file mode 100644 index 0000000000..a6911ad372 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-delete.md @@ -0,0 +1,53 @@ +# `nico-admin-cli rack delete` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **delete**_ + +## NAME + +nico-admin-cli-rack-delete - Delete the rack + +## SYNOPSIS + +**nico-admin-cli rack delete** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*IDENTIFIER*\> + +## DESCRIPTION + +Delete the rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*IDENTIFIER*\> +Rack ID or name to delete (should not have any associated compute trays, +nvlink switches or power shelves) + +## Examples + +```sh +nico-admin-cli rack delete 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli rack delete rack-01 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-force-delete.md b/docs/manuals/nico-admin-cli/commands/rack/rack-force-delete.md new file mode 100644 index 0000000000..1b32d7c68d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-force-delete.md @@ -0,0 +1,45 @@ +# `nico-admin-cli rack force-delete` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **force-delete**_ + +## NAME + +nico-admin-cli-rack-force-delete - Force delete a rack + +## SYNOPSIS + +**nico-admin-cli rack force-delete** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK_ID*\> + +## DESCRIPTION + +Force delete a rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID to force delete. + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-list.md b/docs/manuals/nico-admin-cli/commands/rack/rack-list.md new file mode 100644 index 0000000000..8296b77777 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-list.md @@ -0,0 +1,48 @@ +# `nico-admin-cli rack list` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **list**_ + +## NAME + +nico-admin-cli-rack-list - List all racks + +## SYNOPSIS + +**nico-admin-cli rack list** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +List all racks + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli rack list +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-maintenance-start.md b/docs/manuals/nico-admin-cli/commands/rack/rack-maintenance-start.md new file mode 100644 index 0000000000..3dc142e2cd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-maintenance-start.md @@ -0,0 +1,87 @@ +# `nico-admin-cli rack maintenance start` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [maintenance](./rack-maintenance.md) › **start**_ + +## NAME + +nico-admin-cli-rack-maintenance-start - Start on-demand rack maintenance +(full rack or partial) + +## SYNOPSIS + +**nico-admin-cli rack maintenance start** \<**-r**\|**--rack**\> +\[**--machine-ids**\] \[**--switch-ids**\] \[**--power-shelf-ids**\] +\[**--activities**\] \[**--firmware-version**\] \[**--sot-json-file**\] +\[**--access-token**\] \[**--force-update**\] \[**--components**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Start on-demand rack maintenance (full rack or partial) + +## OPTIONS + +**-r**, **--rack** *\* +Rack ID to start maintenance on + +**--machine-ids** *\...* +Machine IDs to include (omit for full rack) + +**--switch-ids** *\...* +Switch IDs to include (omit for full rack) + +**--power-shelf-ids** *\...* +Power shelf IDs to include (omit for full rack) + +**--activities** *\...* +Maintenance activities to perform: firmware-upgrade, nvos-update, +configure-nmx-cluster, power-sequence (omit for all) + +**--firmware-version** *\* +Raw SOT JSON for firmware-upgrade activity (prefer --sot-json-file) + +**--sot-json-file** *\* +SOT JSON file for RMS ApplyFirmwareObjectFromJSON + +**--access-token** *\* +Artifact access token for RMS SOT JSON downloads; omit or pass empty for +NOAUTH + +**--force-update** +Force firmware update when supported + +**--components** *\...* +Firmware components to update, e.g. BMC,CPLD,BIOS (omit for all +components) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 --machine-ids m1,m2 --activities firmware-upgrade +nico-admin-cli rack maintenance start --rack 12345678-1234-5678-90ab-cdef01234567 --activities firmware-upgrade --sot-json-file ./sot.json --access-token "$TOKEN" --force-update +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-maintenance.md b/docs/manuals/nico-admin-cli/commands/rack/rack-maintenance.md new file mode 100644 index 0000000000..aa0040cc7e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-maintenance.md @@ -0,0 +1,48 @@ +# `nico-admin-cli rack maintenance` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **maintenance**_ + +## NAME + +nico-admin-cli-rack-maintenance - On-demand rack maintenance + +## SYNOPSIS + +**nico-admin-cli rack maintenance** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +On-demand rack maintenance + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`start`](./rack-maintenance-start.md) | Start on-demand rack maintenance (full rack or partial) | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-add-label.md b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-add-label.md new file mode 100644 index 0000000000..fc1a2e951d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-add-label.md @@ -0,0 +1,59 @@ +# `nico-admin-cli rack metadata add-label` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [metadata](./rack-metadata.md) › **add-label**_ + +## NAME + +nico-admin-cli-rack-metadata-add-label - Adds a label to the Metadata of +a Rack + +## SYNOPSIS + +**nico-admin-cli rack metadata add-label** \<**--key**\> \[**--value**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK*\> + +## DESCRIPTION + +Adds a label to the Metadata of a Rack + +## OPTIONS + +**--key** *\* +The key to add + +**--value** *\* +The optional value to add + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK*\> +The rack which should get updated metadata + +## Examples + +```sh +nico-admin-cli rack metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge +nico-admin-cli rack metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key row --value C +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-from-expected-rack.md b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-from-expected-rack.md new file mode 100644 index 0000000000..fc13918ffa --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-from-expected-rack.md @@ -0,0 +1,65 @@ +# `nico-admin-cli rack metadata from-expected-rack` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [metadata](./rack-metadata.md) › **from-expected-rack**_ + +## NAME + +nico-admin-cli-rack-metadata-from-expected-rack - Copy Rack Metadata +from Expected-Rack to Rack + +## SYNOPSIS + +**nico-admin-cli rack metadata from-expected-rack** +\[**--replace-all**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*RACK*\> + +## DESCRIPTION + +Copy Rack Metadata from Expected-Rack to Rack + +## OPTIONS + +**--replace-all** +Whether to fully replace the Metadata that is currently stored on the +Rack. - If not set, existing Metadata on the Rack will not be touched by +executing the command: - The existing Name will not be changed if the +Name is not equivalent to the Rack ID or Empty. - The existing +Description will not be changed if it is not empty. - Existing Labels +and their values will not be changed. Only labels which do not exist on +the Rack will be added. - If set, the Racks Metadata will be set to the +same values as they would if the Rack would get freshly ingested. +Metadata that is currently set on the Rack will be overridden. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK*\> +The rack which should get updated metadata + +## Examples + +```sh +nico-admin-cli rack metadata from-expected-rack 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli rack metadata from-expected-rack 12345678-1234-5678-90ab-cdef01234567 --replace-all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-remove-labels.md b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-remove-labels.md new file mode 100644 index 0000000000..b42f2d3640 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-remove-labels.md @@ -0,0 +1,55 @@ +# `nico-admin-cli rack metadata remove-labels` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [metadata](./rack-metadata.md) › **remove-labels**_ + +## NAME + +nico-admin-cli-rack-metadata-remove-labels - Removes labels from the +Metadata of a Rack + +## SYNOPSIS + +**nico-admin-cli rack metadata remove-labels** \[**--keys**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK*\> + +## DESCRIPTION + +Removes labels from the Metadata of a Rack + +## OPTIONS + +**--keys** *\* +The keys to remove + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK*\> +The rack which should get updated metadata + +## Examples + +```sh +nico-admin-cli rack metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 --keys row --keys edge +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-set.md b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-set.md new file mode 100644 index 0000000000..438b62ba00 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-set.md @@ -0,0 +1,59 @@ +# `nico-admin-cli rack metadata set` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [metadata](./rack-metadata.md) › **set**_ + +## NAME + +nico-admin-cli-rack-metadata-set - Set the Name or Description of the +Rack + +## SYNOPSIS + +**nico-admin-cli rack metadata set** \[**--name**\] +\[**--description**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*RACK*\> + +## DESCRIPTION + +Set the Name or Description of the Rack + +## OPTIONS + +**--name** *\* +The updated name of the Rack + +**--description** *\* +The updated description of the Rack + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK*\> +The rack which should get updated metadata + +## Examples + +```sh +nico-admin-cli rack metadata set 12345678-1234-5678-90ab-cdef01234567 --name rack-01 --description "Row C, position 1" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-show.md b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-show.md new file mode 100644 index 0000000000..fb8ce3b8dd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata-show.md @@ -0,0 +1,51 @@ +# `nico-admin-cli rack metadata show` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [metadata](./rack-metadata.md) › **show**_ + +## NAME + +nico-admin-cli-rack-metadata-show - Show the Metadata of the Rack + +## SYNOPSIS + +**nico-admin-cli rack metadata show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK*\> + +## DESCRIPTION + +Show the Metadata of the Rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK*\> +The rack which should get its metadata displayed + +## Examples + +```sh +nico-admin-cli rack metadata show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-metadata.md b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata.md new file mode 100644 index 0000000000..7ba6b195a7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-metadata.md @@ -0,0 +1,52 @@ +# `nico-admin-cli rack metadata` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **metadata**_ + +## NAME + +nico-admin-cli-rack-metadata - Edit Metadata associated with a Rack + +## SYNOPSIS + +**nico-admin-cli rack metadata** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Edit Metadata associated with a Rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set`](./rack-metadata-set.md) | Set the Name or Description of the Rack | +| [`show`](./rack-metadata-show.md) | Show the Metadata of the Rack | +| [`add-label`](./rack-metadata-add-label.md) | Adds a label to the Metadata of a Rack | +| [`remove-labels`](./rack-metadata-remove-labels.md) | Removes labels from the Metadata of a Rack | +| [`from-expected-rack`](./rack-metadata-from-expected-rack.md) | Copy Rack Metadata from Expected-Rack to Rack | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-profile-show.md b/docs/manuals/nico-admin-cli/commands/rack/rack-profile-show.md new file mode 100644 index 0000000000..feecb48acc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-profile-show.md @@ -0,0 +1,51 @@ +# `nico-admin-cli rack profile show` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › [profile](./rack-profile.md) › **show**_ + +## NAME + +nico-admin-cli-rack-profile-show - Show rack profile for a given rack + +## SYNOPSIS + +**nico-admin-cli rack profile show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK_ID*\> + +## DESCRIPTION + +Show rack profile for a given rack + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID to get profile for + +## Examples + +```sh +nico-admin-cli rack profile show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-profile.md b/docs/manuals/nico-admin-cli/commands/rack/rack-profile.md new file mode 100644 index 0000000000..18421833af --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-profile.md @@ -0,0 +1,48 @@ +# `nico-admin-cli rack profile` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **profile**_ + +## NAME + +nico-admin-cli-rack-profile - Rack profile + +## SYNOPSIS + +**nico-admin-cli rack profile** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Rack profile + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./rack-profile-show.md) | Show rack profile for a given rack | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack-show.md b/docs/manuals/nico-admin-cli/commands/rack/rack-show.md new file mode 100644 index 0000000000..57f84e6d66 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli rack show` + +_[Hardware commands](../../hardware.md) › [rack](./rack.md) › **show**_ + +## NAME + +nico-admin-cli-rack-show - Show rack information + +## SYNOPSIS + +**nico-admin-cli rack show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*RACK*\] + +## DESCRIPTION + +Show rack information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*RACK*\] +Rack ID to show (leave empty for all) + +## Examples + +```sh +nico-admin-cli rack show +nico-admin-cli rack show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rack/rack.md b/docs/manuals/nico-admin-cli/commands/rack/rack.md new file mode 100644 index 0000000000..3bb7a9a551 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rack/rack.md @@ -0,0 +1,54 @@ +# `nico-admin-cli rack` + +_[Hardware commands](../../hardware.md) › **rack**_ + +## NAME + +nico-admin-cli-rack - Rack Management + +## SYNOPSIS + +**nico-admin-cli rack** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Rack Management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./rack-show.md) | Show rack information | +| [`list`](./rack-list.md) | List all racks | +| [`delete`](./rack-delete.md) | Delete the rack | +| [`force-delete`](./rack-force-delete.md) | Force delete a rack | +| [`metadata`](./rack-metadata.md) | Edit Metadata associated with a Rack | +| [`profile`](./rack-profile.md) | Rack profile | +| [`maintenance`](./rack-maintenance.md) | On-demand rack maintenance | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-ac-power-cycle.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-ac-power-cycle.md new file mode 100644 index 0000000000..d58b9842a1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-ac-power-cycle.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish ac-power-cycle` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **ac-power-cycle**_ + +## NAME + +nico-admin-cli-redfish-ac-power-cycle - AC power cycle + +## SYNOPSIS + +**nico-admin-cli redfish ac-power-cycle** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +AC power cycle + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-bios-attrs.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-bios-attrs.md new file mode 100644 index 0000000000..9fa59c9732 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-bios-attrs.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish bios-attrs` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **bios-attrs**_ + +## NAME + +nico-admin-cli-redfish-bios-attrs - List BIOS attributes + +## SYNOPSIS + +**nico-admin-cli redfish bios-attrs** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List BIOS attributes + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-bmc-reset-to-defaults.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-bmc-reset-to-defaults.md new file mode 100644 index 0000000000..630269c352 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-bmc-reset-to-defaults.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish bmc-reset-to-defaults` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **bmc-reset-to-defaults**_ + +## NAME + +nico-admin-cli-redfish-bmc-reset-to-defaults - Reset BMC to factory +defaults + +## SYNOPSIS + +**nico-admin-cli redfish bmc-reset-to-defaults** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Reset BMC to factory defaults + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-bmc-reset.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-bmc-reset.md new file mode 100644 index 0000000000..1b5aa4a47e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-bmc-reset.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish bmc-reset` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **bmc-reset**_ + +## NAME + +nico-admin-cli-redfish-bmc-reset - Reboot the BMC itself + +## SYNOPSIS + +**nico-admin-cli redfish bmc-reset** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Reboot the BMC itself + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-hdd.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-hdd.md new file mode 100644 index 0000000000..3b55963ef6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-hdd.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish boot-hdd` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **boot-hdd**_ + +## NAME + +nico-admin-cli-redfish-boot-hdd - Set hard drive first in boot order + +## SYNOPSIS + +**nico-admin-cli redfish boot-hdd** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Set hard drive first in boot order + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-hdd.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-hdd.md new file mode 100644 index 0000000000..0fe739dd47 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-hdd.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish boot-once-hdd` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **boot-once-hdd**_ + +## NAME + +nico-admin-cli-redfish-boot-once-hdd - On next boot only, boot from hard +drive + +## SYNOPSIS + +**nico-admin-cli redfish boot-once-hdd** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +On next boot only, boot from hard drive + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-pxe.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-pxe.md new file mode 100644 index 0000000000..4719c28949 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-pxe.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish boot-once-pxe` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **boot-once-pxe**_ + +## NAME + +nico-admin-cli-redfish-boot-once-pxe - On next boot only, boot from PXE + +## SYNOPSIS + +**nico-admin-cli redfish boot-once-pxe** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +On next boot only, boot from PXE + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-uefi-http.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-uefi-http.md new file mode 100644 index 0000000000..c255782f61 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-once-uefi-http.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish boot-once-uefi-http` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **boot-once-uefi-http**_ + +## NAME + +nico-admin-cli-redfish-boot-once-uefi-http - Boot rom UEFI HTTP Once + +## SYNOPSIS + +**nico-admin-cli redfish boot-once-uefi-http** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Boot rom UEFI HTTP Once + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-pxe.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-pxe.md new file mode 100644 index 0000000000..9260d46cb5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-pxe.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish boot-pxe` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **boot-pxe**_ + +## NAME + +nico-admin-cli-redfish-boot-pxe - Set PXE first in boot order + +## SYNOPSIS + +**nico-admin-cli redfish boot-pxe** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Set PXE first in boot order + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-uefi-http.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-uefi-http.md new file mode 100644 index 0000000000..d3fe1fa464 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-boot-uefi-http.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish boot-uefi-http` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **boot-uefi-http**_ + +## NAME + +nico-admin-cli-redfish-boot-uefi-http - Set Boot order to UEFI Http +First + +## SYNOPSIS + +**nico-admin-cli redfish boot-uefi-http** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set Boot order to UEFI Http First + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-bmc-password.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-bmc-password.md new file mode 100644 index 0000000000..88ed0a2bc8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-bmc-password.md @@ -0,0 +1,56 @@ +# `nico-admin-cli redfish change-bmc-password` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **change-bmc-password**_ + +## NAME + +nico-admin-cli-redfish-change-bmc-password - Change password for a BMC +user + +## SYNOPSIS + +**nico-admin-cli redfish change-bmc-password** \<**--new-password**\> +\<**--user**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Change password for a BMC user + +## OPTIONS + +**--new-password** *\* +New BMC password + +**--user** *\* +BMC user + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword change-bmc-password --user svc-ops --new-password 'mynewpassword' +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-bmc-username.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-bmc-username.md new file mode 100644 index 0000000000..48e4929b9e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-bmc-username.md @@ -0,0 +1,55 @@ +# `nico-admin-cli redfish change-bmc-username` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **change-bmc-username**_ + +## NAME + +nico-admin-cli-redfish-change-bmc-username - Rename an account + +## SYNOPSIS + +**nico-admin-cli redfish change-bmc-username** \<**--old-user**\> +\<**--new-user**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Rename an account + +## OPTIONS + +**--old-user** *\* +Old username + +**--new-user** *\* +New username + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword change-bmc-username --old-user svc-ops --new-user svc-platform +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-uefi-password.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-uefi-password.md new file mode 100644 index 0000000000..0b64841910 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-change-uefi-password.md @@ -0,0 +1,55 @@ +# `nico-admin-cli redfish change-uefi-password` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **change-uefi-password**_ + +## NAME + +nico-admin-cli-redfish-change-uefi-password - Change UEFI password + +## SYNOPSIS + +**nico-admin-cli redfish change-uefi-password** +\<**--current-password**\> \<**--new-password**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Change UEFI password + +## OPTIONS + +**--current-password** *\* +Current UEFI password + +**--new-password** *\* +New UEFI password + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword change-uefi-password --current-password mycurrentpassword --new-password mynewpassword +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-chassis-reset-card1-powercycle.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-chassis-reset-card1-powercycle.md new file mode 100644 index 0000000000..24fc00bfc7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-chassis-reset-card1-powercycle.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish chassis-reset-card1-powercycle` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **chassis-reset-card1-powercycle**_ + +## NAME + +nico-admin-cli-redfish-chassis-reset-card1-powercycle - Power cycle a +machine + +## SYNOPSIS + +**nico-admin-cli redfish chassis-reset-card1-powercycle** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Power cycle a machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-nvram.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-nvram.md new file mode 100644 index 0000000000..70b68b5dc7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-nvram.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish clear-nvram` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **clear-nvram**_ + +## NAME + +nico-admin-cli-redfish-clear-nvram - Clear Nvram (Viking only) + +## SYNOPSIS + +**nico-admin-cli redfish clear-nvram** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Clear Nvram (Viking only) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-pending.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-pending.md new file mode 100644 index 0000000000..3921edfc86 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-pending.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish clear-pending` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **clear-pending**_ + +## NAME + +nico-admin-cli-redfish-clear-pending - Delete all pending jobs + +## SYNOPSIS + +**nico-admin-cli redfish clear-pending** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete all pending jobs + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-uefi-password.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-uefi-password.md new file mode 100644 index 0000000000..0981ee66fe --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-clear-uefi-password.md @@ -0,0 +1,55 @@ +# `nico-admin-cli redfish clear-uefi-password` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **clear-uefi-password**_ + +## NAME + +nico-admin-cli-redfish-clear-uefi-password - Clear UEFI password + +## SYNOPSIS + +**nico-admin-cli redfish clear-uefi-password** +\<**--current-password**\> \<**--new-password**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Clear UEFI password + +## OPTIONS + +**--current-password** *\* +Current UEFI password + +**--new-password** *\* +New UEFI password + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword clear-uefi-password --current-password mycurrentpassword --new-password '' +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-create-bmc-user.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-create-bmc-user.md new file mode 100644 index 0000000000..9b185b59b2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-create-bmc-user.md @@ -0,0 +1,70 @@ +# `nico-admin-cli redfish create-bmc-user` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **create-bmc-user**_ + +## NAME + +nico-admin-cli-redfish-create-bmc-user - Create new BMC user + +## SYNOPSIS + +**nico-admin-cli redfish create-bmc-user** \<**--new-password**\> +\<**--user**\> \[**--role-id**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Create new BMC user + +## OPTIONS + +**--new-password** *\* +BMC password + +**--user** *\* +BMC user + +**--role-id** *\* +BMC role for the new account (default: administrator)\ + +\ +*Possible values:* + +- administrator + +- operator + +- readonly + +- noaccess + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword create-bmc-user --user svc-ops --new-password 'mynewpassword' +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword create-bmc-user --user auditor --new-password 'mynewpassword' --role-id readonly +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-create-volume.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-create-volume.md new file mode 100644 index 0000000000..4caf185151 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-create-volume.md @@ -0,0 +1,55 @@ +# `nico-admin-cli redfish create-volume` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **create-volume**_ + +## NAME + +nico-admin-cli-redfish-create-volume - Create a storage volume + +## SYNOPSIS + +**nico-admin-cli redfish create-volume** \<**--controller-id**\> +\<**--volume-name**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Create a storage volume + +## OPTIONS + +**--controller-id** *\* +controller_id + +**--volume-name** *\* +volume_name + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword create-volume --controller-id RAID.Slot.1-1 --volume-name data0 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-decommission-controller.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-decommission-controller.md new file mode 100644 index 0000000000..70bb6e92be --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-decommission-controller.md @@ -0,0 +1,53 @@ +# `nico-admin-cli redfish decommission-controller` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **decommission-controller**_ + +## NAME + +nico-admin-cli-redfish-decommission-controller - Decommission a storage +controller + +## SYNOPSIS + +**nico-admin-cli redfish decommission-controller** +\<**--controller-id**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Decommission a storage controller + +## OPTIONS + +**--controller-id** *\* +controller_id + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword decommission-controller --controller-id RAID.Slot.1-1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-delete-bmc-user.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-delete-bmc-user.md new file mode 100644 index 0000000000..e774cc4022 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-delete-bmc-user.md @@ -0,0 +1,51 @@ +# `nico-admin-cli redfish delete-bmc-user` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **delete-bmc-user**_ + +## NAME + +nico-admin-cli-redfish-delete-bmc-user - Create new BMC user + +## SYNOPSIS + +**nico-admin-cli redfish delete-bmc-user** \<**--user**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Create new BMC user + +## OPTIONS + +**--user** *\* +BMC user + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword delete-bmc-user --user svc-ops +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-host-rshim.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-host-rshim.md new file mode 100644 index 0000000000..210e4add81 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-host-rshim.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish disable-host-rshim` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **disable-host-rshim**_ + +## NAME + +nico-admin-cli-redfish-disable-host-rshim - Disable rshim on dpu + +## SYNOPSIS + +**nico-admin-cli redfish disable-host-rshim** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Disable rshim on dpu + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-ipmi-over-lan.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-ipmi-over-lan.md new file mode 100644 index 0000000000..0a7d23f9e9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-ipmi-over-lan.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish disable-ipmi-over-lan` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **disable-ipmi-over-lan**_ + +## NAME + +nico-admin-cli-redfish-disable-ipmi-over-lan - Disable IPMI over LAN + +## SYNOPSIS + +**nico-admin-cli redfish disable-ipmi-over-lan** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Disable IPMI over LAN + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-secure-boot.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-secure-boot.md new file mode 100644 index 0000000000..10c5ee5afc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-disable-secure-boot.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish disable-secure-boot` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **disable-secure-boot**_ + +## NAME + +nico-admin-cli-redfish-disable-secure-boot - Disable Secure Boot + +## SYNOPSIS + +**nico-admin-cli redfish disable-secure-boot** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Disable Secure Boot + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-show.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-show.md new file mode 100644 index 0000000000..6c9e1e9793 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-show.md @@ -0,0 +1,68 @@ +# `nico-admin-cli redfish dpu firmware show` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › [dpu](./redfish-dpu.md) › [firmware](./redfish-dpu-firmware.md) › **show**_ + +## NAME + +nico-admin-cli-redfish-dpu-firmware-show - Show FW versions of different +components + +## SYNOPSIS + +**nico-admin-cli redfish dpu firmware show** \[**-a**\|**--all**\] +\[**--bmc**\] \[**--dpu-os**\] \[**--uefi**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*FW*\] + +## DESCRIPTION + +Show FW versions of different components + +## OPTIONS + +**-a**, **--all** +Show all discovered firmware key/values + +**--bmc** +Show BMC FW Version + +**--dpu-os** +Show DPU OS version (shortcut for \`show DPU_OS\`) + +**--uefi** +Show UEFI version (shortcut for \`show DPU_UEFI\`) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*FW*\] \[default: \] +The firmware type to query (e.g. DPU_OS, DPU_UEFI, DPU_NIC), leave empty +for all (default) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware show --all +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware show --dpu-os +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware show DPU_NIC +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-status.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-status.md new file mode 100644 index 0000000000..a414251c3e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-status.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish dpu firmware status` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › [dpu](./redfish-dpu.md) › [firmware](./redfish-dpu-firmware.md) › **status**_ + +## NAME + +nico-admin-cli-redfish-dpu-firmware-status - Print FW update status + +## SYNOPSIS + +**nico-admin-cli redfish dpu firmware status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print FW update status + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-update.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-update.md new file mode 100644 index 0000000000..d3cfd69b18 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware-update.md @@ -0,0 +1,52 @@ +# `nico-admin-cli redfish dpu firmware update` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › [dpu](./redfish-dpu.md) › [firmware](./redfish-dpu-firmware.md) › **update**_ + +## NAME + +nico-admin-cli-redfish-dpu-firmware-update - Update BMCs FW to the given +FW package + +## SYNOPSIS + +**nico-admin-cli redfish dpu firmware update** \<**-p**\|**--package**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Update BMCs FW to the given FW package + +## OPTIONS + +**-p**, **--package** *\* +FW package to install + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware update --package ./bmc-fw.fwpkg +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware.md new file mode 100644 index 0000000000..c2e79147d3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-firmware.md @@ -0,0 +1,58 @@ +# `nico-admin-cli redfish dpu firmware` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › [dpu](./redfish-dpu.md) › **firmware**_ + +## NAME + +nico-admin-cli-redfish-dpu-firmware - BMCs FW Commands + +## SYNOPSIS + +**nico-admin-cli redfish dpu firmware** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +BMCs FW Commands + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware status +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware update --package ./bmc-fw.fwpkg +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware show --all +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`status`](./redfish-dpu-firmware-status.md) | Print FW update status | +| [`update`](./redfish-dpu-firmware-update.md) | Update BMC's FW to the given FW package | +| [`show`](./redfish-dpu-firmware-show.md) | Show FW versions of different components | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-ports.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-ports.md new file mode 100644 index 0000000000..812ed7c42c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu-ports.md @@ -0,0 +1,55 @@ +# `nico-admin-cli redfish dpu ports` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › [dpu](./redfish-dpu.md) › **ports**_ + +## NAME + +nico-admin-cli-redfish-dpu-ports - Show ports information + +## SYNOPSIS + +**nico-admin-cli redfish dpu ports** \[**-a**\|**--all**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*PORT*\] + +## DESCRIPTION + +Show ports information + +## OPTIONS + +**-a**, **--all** +Show all ports (DEPRECATED) + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*PORT*\] \[default: \] +The port to query (e.g. eth0, eth1), leave empty for all (default) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu ports +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu ports eth0 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu.md new file mode 100644 index 0000000000..6822f5cdd6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-dpu.md @@ -0,0 +1,56 @@ +# `nico-admin-cli redfish dpu` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **dpu**_ + +## NAME + +nico-admin-cli-redfish-dpu - DPU specific operations + +## SYNOPSIS + +**nico-admin-cli redfish dpu** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +DPU specific operations + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu firmware show --all +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword dpu ports +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`firmware`](./redfish-dpu-firmware.md) | BMC's FW Commands | +| [`ports`](./redfish-dpu-ports.md) | Show ports information | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-host-rshim.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-host-rshim.md new file mode 100644 index 0000000000..d1fae7891a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-host-rshim.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish enable-host-rshim` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **enable-host-rshim**_ + +## NAME + +nico-admin-cli-redfish-enable-host-rshim - Enable rshim on DPU + +## SYNOPSIS + +**nico-admin-cli redfish enable-host-rshim** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable rshim on DPU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-infinite-boot.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-infinite-boot.md new file mode 100644 index 0000000000..5ab3a64e48 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-infinite-boot.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish enable-infinite-boot` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **enable-infinite-boot**_ + +## NAME + +nico-admin-cli-redfish-enable-infinite-boot - Enable infinite boot + +## SYNOPSIS + +**nico-admin-cli redfish enable-infinite-boot** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable infinite boot + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-ipmi-over-lan.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-ipmi-over-lan.md new file mode 100644 index 0000000000..ac273d041a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-enable-ipmi-over-lan.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish enable-ipmi-over-lan` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **enable-ipmi-over-lan**_ + +## NAME + +nico-admin-cli-redfish-enable-ipmi-over-lan - Enable IPMI over LAN + +## SYNOPSIS + +**nico-admin-cli redfish enable-ipmi-over-lan** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable IPMI over LAN + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-force-off.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-force-off.md new file mode 100644 index 0000000000..629e31d07c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-force-off.md @@ -0,0 +1,48 @@ +# `nico-admin-cli redfish force-off` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **force-off**_ + +## NAME + +nico-admin-cli-redfish-force-off - Force turn machine off + +## SYNOPSIS + +**nico-admin-cli redfish force-off** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Force turn machine off + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-off +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-force-restart.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-force-restart.md new file mode 100644 index 0000000000..a67aa09ac7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-force-restart.md @@ -0,0 +1,52 @@ +# `nico-admin-cli redfish force-restart` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **force-restart**_ + +## NAME + +nico-admin-cli-redfish-force-restart - Force restart. This is equivalent +to pressing the reset button on the front panel. - Will not restart +DPUs - Will apply pending BIOS/UEFI setting changes + +## SYNOPSIS + +**nico-admin-cli redfish force-restart** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Force restart. This is equivalent to pressing the reset button on the +front panel. - Will not restart DPUs - Will apply pending BIOS/UEFI +setting changes + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-restart +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-base-mac-address.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-base-mac-address.md new file mode 100644 index 0000000000..3d288b8f77 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-base-mac-address.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish get-base-mac-address` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-base-mac-address**_ + +## NAME + +nico-admin-cli-redfish-get-base-mac-address - Get Base Mac Address (DPU +only) + +## SYNOPSIS + +**nico-admin-cli redfish get-base-mac-address** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get Base Mac Address (DPU only) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-bmc-accounts.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-bmc-accounts.md new file mode 100644 index 0000000000..d4834d65aa --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-bmc-accounts.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-bmc-accounts` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-bmc-accounts**_ + +## NAME + +nico-admin-cli-redfish-get-bmc-accounts - List of existing BMC accounts + +## SYNOPSIS + +**nico-admin-cli redfish get-bmc-accounts** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List of existing BMC accounts + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-bmc-ethernet-interfaces.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-bmc-ethernet-interfaces.md new file mode 100644 index 0000000000..3732a1121a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-bmc-ethernet-interfaces.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish get-bmc-ethernet-interfaces` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-bmc-ethernet-interfaces**_ + +## NAME + +nico-admin-cli-redfish-get-bmc-ethernet-interfaces - Show BMCs Ethernet +interface information + +## SYNOPSIS + +**nico-admin-cli redfish get-bmc-ethernet-interfaces** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show BMCs Ethernet interface information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-boot-option.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-boot-option.md new file mode 100644 index 0000000000..91d52b8ba6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-boot-option.md @@ -0,0 +1,52 @@ +# `nico-admin-cli redfish get-boot-option` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-boot-option**_ + +## NAME + +nico-admin-cli-redfish-get-boot-option - List one or all BIOS boot +options + +## SYNOPSIS + +**nico-admin-cli redfish get-boot-option** \[**--all**\] \[**--id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List one or all BIOS boot options + +## OPTIONS + +**--all** +**--id** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-boot-option --all +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-boot-option --id Boot0001 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-boss-controller.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-boss-controller.md new file mode 100644 index 0000000000..0299feb719 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-boss-controller.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-boss-controller` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-boss-controller**_ + +## NAME + +nico-admin-cli-redfish-get-boss-controller - Get the Boss Controller + +## SYNOPSIS + +**nico-admin-cli redfish get-boss-controller** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get the Boss Controller + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-chassis-all.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-chassis-all.md new file mode 100644 index 0000000000..6e061b68f6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-chassis-all.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-chassis-all` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-chassis-all**_ + +## NAME + +nico-admin-cli-redfish-get-chassis-all - List Chassis + +## SYNOPSIS + +**nico-admin-cli redfish get-chassis-all** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List Chassis + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-chassis.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-chassis.md new file mode 100644 index 0000000000..e4a2d8ef04 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-chassis.md @@ -0,0 +1,51 @@ +# `nico-admin-cli redfish get-chassis` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-chassis**_ + +## NAME + +nico-admin-cli-redfish-get-chassis - List Chassis Subsystem + +## SYNOPSIS + +**nico-admin-cli redfish get-chassis** \<**--chassis-id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List Chassis Subsystem + +## OPTIONS + +**--chassis-id** *\* +Chassis ID + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-chassis --chassis-id Chassis-1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-host-rshim.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-host-rshim.md new file mode 100644 index 0000000000..aa5b6b6328 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-host-rshim.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish get-host-rshim` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-host-rshim**_ + +## NAME + +nico-admin-cli-redfish-get-host-rshim - Get status of the rshim process +on DPU + +## SYNOPSIS + +**nico-admin-cli redfish get-host-rshim** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get status of the rshim process on DPU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-manager.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-manager.md new file mode 100644 index 0000000000..fea09120e1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-manager.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-manager` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-manager**_ + +## NAME + +nico-admin-cli-redfish-get-manager - Get information about the managers + +## SYNOPSIS + +**nico-admin-cli redfish get-manager** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get information about the managers + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-nic-mode.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-nic-mode.md new file mode 100644 index 0000000000..75742e1509 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-nic-mode.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-nic-mode` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-nic-mode**_ + +## NAME + +nico-admin-cli-redfish-get-nic-mode - Get DPU mode + +## SYNOPSIS + +**nico-admin-cli redfish get-nic-mode** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get DPU mode + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-power-state.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-power-state.md new file mode 100644 index 0000000000..8245236c77 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-power-state.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-power-state` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-power-state**_ + +## NAME + +nico-admin-cli-redfish-get-power-state - Is this thing on? + +## SYNOPSIS + +**nico-admin-cli redfish get-power-state** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Is this thing on? + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-secure-boot.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-secure-boot.md new file mode 100644 index 0000000000..3cd44f5a78 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-secure-boot.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-secure-boot` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-secure-boot**_ + +## NAME + +nico-admin-cli-redfish-get-secure-boot - Get Secure boot status + +## SYNOPSIS + +**nico-admin-cli redfish get-secure-boot** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get Secure boot status + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-system-ethernet-interfaces.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-system-ethernet-interfaces.md new file mode 100644 index 0000000000..b6b2855594 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-system-ethernet-interfaces.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish get-system-ethernet-interfaces` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-system-ethernet-interfaces**_ + +## NAME + +nico-admin-cli-redfish-get-system-ethernet-interfaces - Show System +Ethernet interface information + +## SYNOPSIS + +**nico-admin-cli redfish get-system-ethernet-interfaces** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show System Ethernet interface information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-task.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-task.md new file mode 100644 index 0000000000..f53b3d234d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-task.md @@ -0,0 +1,51 @@ +# `nico-admin-cli redfish get-task` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-task**_ + +## NAME + +nico-admin-cli-redfish-get-task - Get detailed info on a Redfish task + +## SYNOPSIS + +**nico-admin-cli redfish get-task** \<**--taskid**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get detailed info on a Redfish task + +## OPTIONS + +**--taskid** *\* +Task ID + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-task --taskid JID_123456789012 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-tasks.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-tasks.md new file mode 100644 index 0000000000..de3e1e0339 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-get-tasks.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish get-tasks` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **get-tasks**_ + +## NAME + +nico-admin-cli-redfish-get-tasks - Get a list of Redfish tasks + +## SYNOPSIS + +**nico-admin-cli redfish get-tasks** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get a list of Redfish tasks + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-graceful-restart.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-graceful-restart.md new file mode 100644 index 0000000000..e072b098c1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-graceful-restart.md @@ -0,0 +1,51 @@ +# `nico-admin-cli redfish graceful-restart` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **graceful-restart**_ + +## NAME + +nico-admin-cli-redfish-graceful-restart - Graceful restart. Asks the OS +to restart via ACPI - Might restart DPUs if no OS is running - Will not +apply pending BIOS/UEFI setting changes + +## SYNOPSIS + +**nico-admin-cli redfish graceful-restart** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Graceful restart. Asks the OS to restart via ACPI - Might restart DPUs +if no OS is running - Will not apply pending BIOS/UEFI setting changes + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword graceful-restart +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-graceful-shutdown.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-graceful-shutdown.md new file mode 100644 index 0000000000..fd1ebbd553 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-graceful-shutdown.md @@ -0,0 +1,48 @@ +# `nico-admin-cli redfish graceful-shutdown` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **graceful-shutdown**_ + +## NAME + +nico-admin-cli-redfish-graceful-shutdown - Graceful host shutdown + +## SYNOPSIS + +**nico-admin-cli redfish graceful-shutdown** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Graceful host shutdown + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword graceful-shutdown +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-boot-order-setup.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-boot-order-setup.md new file mode 100644 index 0000000000..174be12c9d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-boot-order-setup.md @@ -0,0 +1,54 @@ +# `nico-admin-cli redfish is-boot-order-setup` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **is-boot-order-setup**_ + +## NAME + +nico-admin-cli-redfish-is-boot-order-setup - Check if boot order is set +correctly Check whether the DPU-first boot order is already configured + +## SYNOPSIS + +**nico-admin-cli redfish is-boot-order-setup** +\<**--boot-interface-mac**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Check if boot order is set correctly Check whether the DPU-first boot +order is already configured + +## OPTIONS + +**--boot-interface-mac** *\* +boot_interface_mac + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword is-boot-order-setup --boot-interface-mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-infinite-boot-enabled.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-infinite-boot-enabled.md new file mode 100644 index 0000000000..93dfcae67c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-infinite-boot-enabled.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish is-infinite-boot-enabled` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **is-infinite-boot-enabled**_ + +## NAME + +nico-admin-cli-redfish-is-infinite-boot-enabled - Is infinite boot +enable + +## SYNOPSIS + +**nico-admin-cli redfish is-infinite-boot-enabled** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Is infinite boot enable + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-ipmi-over-lan-enabled.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-ipmi-over-lan-enabled.md new file mode 100644 index 0000000000..5c58e0486c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-is-ipmi-over-lan-enabled.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish is-ipmi-over-lan-enabled` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **is-ipmi-over-lan-enabled**_ + +## NAME + +nico-admin-cli-redfish-is-ipmi-over-lan-enabled - Is IPMI enabled over +LAN + +## SYNOPSIS + +**nico-admin-cli redfish is-ipmi-over-lan-enabled** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Is IPMI enabled over LAN + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-local-storage.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-local-storage.md new file mode 100644 index 0000000000..a2552383f5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-local-storage.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish local-storage` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **local-storage**_ + +## NAME + +nico-admin-cli-redfish-local-storage - List Direct Attached drives + +## SYNOPSIS + +**nico-admin-cli redfish local-storage** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List Direct Attached drives + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-disable.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-disable.md new file mode 100644 index 0000000000..4882c053a6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-disable.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish lockdown-disable` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **lockdown-disable**_ + +## NAME + +nico-admin-cli-redfish-lockdown-disable - Disable BMC/BIOS lockdown + +## SYNOPSIS + +**nico-admin-cli redfish lockdown-disable** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Disable BMC/BIOS lockdown + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-enable.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-enable.md new file mode 100644 index 0000000000..0d5142905c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-enable.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish lockdown-enable` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **lockdown-enable**_ + +## NAME + +nico-admin-cli-redfish-lockdown-enable - Enable BMC/BIOS lockdown + +## SYNOPSIS + +**nico-admin-cli redfish lockdown-enable** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable BMC/BIOS lockdown + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-status.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-status.md new file mode 100644 index 0000000000..9f658222bb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-lockdown-status.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish lockdown-status` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **lockdown-status**_ + +## NAME + +nico-admin-cli-redfish-lockdown-status - Display status of BMC/BIOS +lockdown + +## SYNOPSIS + +**nico-admin-cli redfish lockdown-status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Display status of BMC/BIOS lockdown + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-machine-setup-status.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-machine-setup-status.md new file mode 100644 index 0000000000..0c45e511ca --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-machine-setup-status.md @@ -0,0 +1,53 @@ +# `nico-admin-cli redfish machine-setup-status` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **machine-setup-status**_ + +## NAME + +nico-admin-cli-redfish-machine-setup-status - Is everything MachineSetup +does already done? Whats missing? + +## SYNOPSIS + +**nico-admin-cli redfish machine-setup-status** +\[**--boot-interface-mac**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Is everything MachineSetup does already done? Whats missing? + +## OPTIONS + +**--boot-interface-mac** *\* +boot_interface_mac + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword machine-setup-status --boot-interface-mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-machine-setup.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-machine-setup.md new file mode 100644 index 0000000000..1c6bc89875 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-machine-setup.md @@ -0,0 +1,65 @@ +# `nico-admin-cli redfish machine-setup` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **machine-setup**_ + +## NAME + +nico-admin-cli-redfish-machine-setup - Setup host for use + +## SYNOPSIS + +**nico-admin-cli redfish machine-setup** \[**--boot-interface-mac**\] +\[**--bios-profiles**\] \[**--selected-profile**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Setup host for use + +## OPTIONS + +**--boot-interface-mac** *\* +boot_interface_mac + +**--bios-profiles** *\* +BIOS profile config in JSON format + +**--selected-profile** *\* +BIOS profile to use\ + +\ +*Possible values:* + +- performance + +- power-efficiency + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword machine-setup --boot-interface-mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-on.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-on.md new file mode 100644 index 0000000000..b68bf237d5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-on.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish on` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **on**_ + +## NAME + +nico-admin-cli-redfish-on - Power on a machine + +## SYNOPSIS + +**nico-admin-cli redfish on** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Power on a machine + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-pcie-devices.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-pcie-devices.md new file mode 100644 index 0000000000..98b0a0e3e0 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-pcie-devices.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish pcie-devices` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **pcie-devices**_ + +## NAME + +nico-admin-cli-redfish-pcie-devices - List PCIe devices + +## SYNOPSIS + +**nico-admin-cli redfish pcie-devices** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List PCIe devices + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-pending.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-pending.md new file mode 100644 index 0000000000..34e0d6c56c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-pending.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish pending` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **pending**_ + +## NAME + +nico-admin-cli-redfish-pending - List pending operations + +## SYNOPSIS + +**nico-admin-cli redfish pending** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +List pending operations + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-power-metrics.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-power-metrics.md new file mode 100644 index 0000000000..f7cd6c8281 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-power-metrics.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish power-metrics` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **power-metrics**_ + +## NAME + +nico-admin-cli-redfish-power-metrics - Display power metrics (voltages, +power supplies, etc) + +## SYNOPSIS + +**nico-admin-cli redfish power-metrics** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Display power metrics (voltages, power supplies, etc) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-serial-enable.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-serial-enable.md new file mode 100644 index 0000000000..c70b8261c6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-serial-enable.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish serial-enable` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **serial-enable**_ + +## NAME + +nico-admin-cli-redfish-serial-enable - Enable serial console + +## SYNOPSIS + +**nico-admin-cli redfish serial-enable** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable serial console + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-serial-status.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-serial-status.md new file mode 100644 index 0000000000..0c75c97ca5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-serial-status.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish serial-status` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **serial-status**_ + +## NAME + +nico-admin-cli-redfish-serial-status - Serial console status + +## SYNOPSIS + +**nico-admin-cli redfish serial-status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Serial console status + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-bios.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-bios.md new file mode 100644 index 0000000000..77267119fb --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-bios.md @@ -0,0 +1,52 @@ +# `nico-admin-cli redfish set-bios` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **set-bios**_ + +## NAME + +nico-admin-cli-redfish-set-bios - Set BIOS options + +## SYNOPSIS + +**nico-admin-cli redfish set-bios** \<**--attributes**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set BIOS options + +## OPTIONS + +**--attributes** *\* +BIOS attributes to set in JSON, ex: +{"OperatingModes_ChooseOperatingMode": "MaximumPerformance"} + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword set-bios --attributes '{"OperatingModes_ChooseOperatingMode": "MaximumPerformance"}' +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-boot-order-dpu-first.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-boot-order-dpu-first.md new file mode 100644 index 0000000000..bf8adc29d3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-boot-order-dpu-first.md @@ -0,0 +1,54 @@ +# `nico-admin-cli redfish set-boot-order-dpu-first` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **set-boot-order-dpu-first**_ + +## NAME + +nico-admin-cli-redfish-set-boot-order-dpu-first - Set the DPU as the +first boot target Set the boot order so the DPU boots first + +## SYNOPSIS + +**nico-admin-cli redfish set-boot-order-dpu-first** +\<**--boot-interface-mac**\> \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Set the DPU as the first boot target Set the boot order so the DPU boots +first + +## OPTIONS + +**--boot-interface-mac** *\* +boot_interface_mac + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword set-boot-order-dpu-first --boot-interface-mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-dpu-mode.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-dpu-mode.md new file mode 100644 index 0000000000..e20060c556 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-dpu-mode.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish set-dpu-mode` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **set-dpu-mode**_ + +## NAME + +nico-admin-cli-redfish-set-dpu-mode - Set DPU mode (host networking via +the DPU) + +## SYNOPSIS + +**nico-admin-cli redfish set-dpu-mode** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set DPU mode (host networking via the DPU) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-forge-password-policy.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-forge-password-policy.md new file mode 100644 index 0000000000..8c9a357358 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-forge-password-policy.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish set-forge-password-policy` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **set-forge-password-policy**_ + +## NAME + +nico-admin-cli-redfish-set-forge-password-policy - Set our password +policy + +## SYNOPSIS + +**nico-admin-cli redfish set-forge-password-policy** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set our password policy + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-nic-mode.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-nic-mode.md new file mode 100644 index 0000000000..89972e0410 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-set-nic-mode.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish set-nic-mode` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **set-nic-mode**_ + +## NAME + +nico-admin-cli-redfish-set-nic-mode - Set NIC mode (host networking via +the NIC) + +## SYNOPSIS + +**nico-admin-cli redfish set-nic-mode** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set NIC mode (host networking via the NIC) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-thermal-metrics.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-thermal-metrics.md new file mode 100644 index 0000000000..37a1911146 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-thermal-metrics.md @@ -0,0 +1,43 @@ +# `nico-admin-cli redfish thermal-metrics` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **thermal-metrics**_ + +## NAME + +nico-admin-cli-redfish-thermal-metrics - Display thermal metrics (fans +and temperatures) + +## SYNOPSIS + +**nico-admin-cli redfish thermal-metrics** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Display thermal metrics (fans and temperatures) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-tpm-reset.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-tpm-reset.md new file mode 100644 index 0000000000..e93283fd98 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-tpm-reset.md @@ -0,0 +1,42 @@ +# `nico-admin-cli redfish tpm-reset` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **tpm-reset**_ + +## NAME + +nico-admin-cli-redfish-tpm-reset - Clear Trusted Platform Module (TPM) + +## SYNOPSIS + +**nico-admin-cli redfish tpm-reset** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Clear Trusted Platform Module (TPM) + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish-update-firmware-multipart.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish-update-firmware-multipart.md new file mode 100644 index 0000000000..279cc1aab3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish-update-firmware-multipart.md @@ -0,0 +1,75 @@ +# `nico-admin-cli redfish update-firmware-multipart` + +_[Hardware commands](../../hardware.md) › [redfish](./redfish.md) › **update-firmware-multipart**_ + +## NAME + +nico-admin-cli-redfish-update-firmware-multipart - Update host firmware + +## SYNOPSIS + +**nico-admin-cli redfish update-firmware-multipart** \<**--filename**\> +\[**--component-type**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Update host firmware + +## OPTIONS + +**--filename** *\* +Local filename for the firmware to be installed + +**--component-type** *\* +Firmware type, ignored by some platforms and optional on others\ + +\ +*Possible values:* + +- bmc + +- uefi + +- erotbmc + +- erotbios + +- cpldmid + +- cpldmb + +- cpldpdb + +- hgxbmc + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword update-firmware-multipart --filename ./host-fw.bin +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword update-firmware-multipart --filename ./uefi.bin --component-type uefi +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/redfish/redfish.md b/docs/manuals/nico-admin-cli/commands/redfish/redfish.md new file mode 100644 index 0000000000..384aeb226e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/redfish/redfish.md @@ -0,0 +1,137 @@ +# `nico-admin-cli redfish` + +_[Hardware commands](../../hardware.md) › **redfish**_ + +## NAME + +nico-admin-cli-redfish - Redfish BMC actions + +## SYNOPSIS + +**nico-admin-cli redfish** \[**--extended**\] \<**--address**\> +\[**--username**\] \[**--password**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Redfish BMC actions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--address** *\* +IP:port of machine BMC. Port is optional and defaults to 443 + +**--username** *\* +Username for machine BMC + +**--password** *\* +Password for machine BMC + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword get-power-state +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword on +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword force-off +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword boot-pxe +nico-admin-cli redfish --address 192.0.2.10 --username admin --password mypassword update-firmware-multipart --filename ./host-fw.bin +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`bios-attrs`](./redfish-bios-attrs.md) | List BIOS attributes | +| [`boot-hdd`](./redfish-boot-hdd.md) | Set hard drive first in boot order | +| [`boot-pxe`](./redfish-boot-pxe.md) | Set PXE first in boot order | +| [`boot-uefi-http`](./redfish-boot-uefi-http.md) | Set Boot order to UEFI Http First | +| [`boot-once-hdd`](./redfish-boot-once-hdd.md) | On next boot only, boot from hard drive | +| [`boot-once-pxe`](./redfish-boot-once-pxe.md) | On next boot only, boot from PXE | +| [`boot-once-uefi-http`](./redfish-boot-once-uefi-http.md) | Boot rom UEFI HTTP Once | +| [`clear-pending`](./redfish-clear-pending.md) | Delete all pending jobs | +| [`create-bmc-user`](./redfish-create-bmc-user.md) | Create new BMC user | +| [`delete-bmc-user`](./redfish-delete-bmc-user.md) | Create new BMC user | +| [`machine-setup`](./redfish-machine-setup.md) | Setup host for use | +| [`machine-setup-status`](./redfish-machine-setup-status.md) | Is everything MachineSetup does already done? What's missing? | +| [`set-forge-password-policy`](./redfish-set-forge-password-policy.md) | Set our password policy | +| [`get-boot-option`](./redfish-get-boot-option.md) | List one or all BIOS boot options | +| [`get-power-state`](./redfish-get-power-state.md) | Is this thing on? | +| [`lockdown-disable`](./redfish-lockdown-disable.md) | Disable BMC/BIOS lockdown | +| [`lockdown-enable`](./redfish-lockdown-enable.md) | Enable BMC/BIOS lockdown | +| [`lockdown-status`](./redfish-lockdown-status.md) | Display status of BMC/BIOS lockdown | +| [`force-off`](./redfish-force-off.md) | Force turn machine off | +| [`force-restart`](./redfish-force-restart.md) | Force restart. This is equivalent to pressing the reset button on the front panel. | +| [`graceful-restart`](./redfish-graceful-restart.md) | Graceful restart. Asks the OS to restart via ACPI | +| [`graceful-shutdown`](./redfish-graceful-shutdown.md) | Graceful host shutdown | +| [`ac-power-cycle`](./redfish-ac-power-cycle.md) | AC power cycle | +| [`on`](./redfish-on.md) | Power on a machine | +| [`pcie-devices`](./redfish-pcie-devices.md) | List PCIe devices | +| [`local-storage`](./redfish-local-storage.md) | List Direct Attached drives | +| [`pending`](./redfish-pending.md) | List pending operations | +| [`power-metrics`](./redfish-power-metrics.md) | Display power metrics (voltages, power supplies, etc) | +| [`serial-enable`](./redfish-serial-enable.md) | Enable serial console | +| [`serial-status`](./redfish-serial-status.md) | Serial console status | +| [`thermal-metrics`](./redfish-thermal-metrics.md) | Display thermal metrics (fans and temperatures) | +| [`tpm-reset`](./redfish-tpm-reset.md) | Clear Trusted Platform Module (TPM) | +| [`bmc-reset-to-defaults`](./redfish-bmc-reset-to-defaults.md) | Reset BMC to factory defaults | +| [`bmc-reset`](./redfish-bmc-reset.md) | Reboot the BMC itself | +| [`get-secure-boot`](./redfish-get-secure-boot.md) | Get Secure boot status | +| [`disable-secure-boot`](./redfish-disable-secure-boot.md) | Disable Secure Boot | +| [`get-chassis-all`](./redfish-get-chassis-all.md) | List Chassis | +| [`get-chassis`](./redfish-get-chassis.md) | List Chassis Subsystem | +| [`get-bmc-ethernet-interfaces`](./redfish-get-bmc-ethernet-interfaces.md) | Show BMC's Ethernet interface information | +| [`get-system-ethernet-interfaces`](./redfish-get-system-ethernet-interfaces.md) | Show System Ethernet interface information | +| [`get-bmc-accounts`](./redfish-get-bmc-accounts.md) | List of existing BMC accounts | +| [`change-bmc-username`](./redfish-change-bmc-username.md) | Rename an account | +| [`change-bmc-password`](./redfish-change-bmc-password.md) | Change password for a BMC user | +| [`change-uefi-password`](./redfish-change-uefi-password.md) | Change UEFI password | +| [`dpu`](./redfish-dpu.md) | DPU specific operations | +| [`get-manager`](./redfish-get-manager.md) | Get information about the managers | +| [`update-firmware-multipart`](./redfish-update-firmware-multipart.md) | Update host firmware | +| [`get-task`](./redfish-get-task.md) | Get detailed info on a Redfish task | +| [`get-tasks`](./redfish-get-tasks.md) | Get a list of Redfish tasks | +| [`clear-uefi-password`](./redfish-clear-uefi-password.md) | Clear UEFI password | +| [`is-ipmi-over-lan-enabled`](./redfish-is-ipmi-over-lan-enabled.md) | Is IPMI enabled over LAN | +| [`enable-ipmi-over-lan`](./redfish-enable-ipmi-over-lan.md) | Enable IPMI over LAN | +| [`disable-ipmi-over-lan`](./redfish-disable-ipmi-over-lan.md) | Disable IPMI over LAN | +| [`get-base-mac-address`](./redfish-get-base-mac-address.md) | Get Base Mac Address (DPU only) | +| [`clear-nvram`](./redfish-clear-nvram.md) | Clear Nvram (Viking only) | +| [`set-bios`](./redfish-set-bios.md) | Set BIOS options | +| [`get-nic-mode`](./redfish-get-nic-mode.md) | Get DPU mode | +| [`is-infinite-boot-enabled`](./redfish-is-infinite-boot-enabled.md) | Is infinite boot enable | +| [`enable-infinite-boot`](./redfish-enable-infinite-boot.md) | Enable infinite boot | +| [`set-nic-mode`](./redfish-set-nic-mode.md) | Set NIC mode (host networking via the NIC) | +| [`set-dpu-mode`](./redfish-set-dpu-mode.md) | Set DPU mode (host networking via the DPU) | +| [`chassis-reset-card1-powercycle`](./redfish-chassis-reset-card1-powercycle.md) | Power cycle a machine | +| [`set-boot-order-dpu-first`](./redfish-set-boot-order-dpu-first.md) | Set the DPU as the first boot target Set the boot order so the DPU boots first | +| [`get-host-rshim`](./redfish-get-host-rshim.md) | Get status of the rshim process on DPU | +| [`enable-host-rshim`](./redfish-enable-host-rshim.md) | Enable rshim on DPU | +| [`disable-host-rshim`](./redfish-disable-host-rshim.md) | Disable rshim on dpu | +| [`get-boss-controller`](./redfish-get-boss-controller.md) | Get the Boss Controller | +| [`decommission-controller`](./redfish-decommission-controller.md) | Decommission a storage controller | +| [`create-volume`](./redfish-create-volume.md) | Create a storage volume | +| [`is-boot-order-setup`](./redfish-is-boot-order-setup.md) | Check if boot order is set correctly Check whether the DPU-first boot order is already configured | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool-grow.md b/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool-grow.md new file mode 100644 index 0000000000..e3199a0c1e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool-grow.md @@ -0,0 +1,52 @@ +# `nico-admin-cli resource-pool grow` + +_[Network commands](../../network.md) › [resource-pool](./resource-pool.md) › **grow**_ + +## NAME + +nico-admin-cli-resource-pool-grow - Add capacity to one or more resource +pools from a TOML file. See carbide-api admin_grow_resource_pool docs +for example TOML. + +## SYNOPSIS + +**nico-admin-cli resource-pool grow** \<**-f**\|**--filename**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add capacity to one or more resource pools from a TOML file. See +carbide-api admin_grow_resource_pool docs for example TOML. + +## OPTIONS + +**-f**, **--filename** *\* +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli resource-pool grow --filename ./grow-pools.toml +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool-list.md b/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool-list.md new file mode 100644 index 0000000000..95ea19c847 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool-list.md @@ -0,0 +1,48 @@ +# `nico-admin-cli resource-pool list` + +_[Network commands](../../network.md) › [resource-pool](./resource-pool.md) › **list**_ + +## NAME + +nico-admin-cli-resource-pool-list - List all resource pools with stats + +## SYNOPSIS + +**nico-admin-cli resource-pool list** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all resource pools with stats + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli resource-pool list +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool.md b/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool.md new file mode 100644 index 0000000000..57ff74d6cd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/resource-pool/resource-pool.md @@ -0,0 +1,49 @@ +# `nico-admin-cli resource-pool` + +_[Network commands](../../network.md) › **resource-pool**_ + +## NAME + +nico-admin-cli-resource-pool - Resource pool handling + +## SYNOPSIS + +**nico-admin-cli resource-pool** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Resource pool handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`grow`](./resource-pool-grow.md) | Add capacity to one or more resource pools from a TOML file. See carbide-api admin_grow_resource_pool docs for example TOML. | +| [`list`](./resource-pool-list.md) | List all resource pools with stats | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rms/rms-firmware-inventory.md b/docs/manuals/nico-admin-cli/commands/rms/rms-firmware-inventory.md new file mode 100644 index 0000000000..7d2950c8ac --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rms/rms-firmware-inventory.md @@ -0,0 +1,69 @@ +# `nico-admin-cli rms firmware-inventory` + +_[Hardware commands](../../hardware.md) › [rms](./rms.md) › **firmware-inventory**_ + +## NAME + +nico-admin-cli-rms-firmware-inventory - Get the firmware inventory for a +given node + +## SYNOPSIS + +**nico-admin-cli rms firmware-inventory** \[**--url**\] +\[**--root-ca**\] \[**--client-cert**\] \[**--client-key**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*RACK_ID*\> \<*NODE_ID*\> + +## DESCRIPTION + +Get the firmware inventory for a given node + +## OPTIONS + +**--url** *\* +URL of RMS API endpoint (required). + +**--root-ca** *\* +Root CA path + +**--client-cert** *\* +Client certificate path + +**--client-key** *\* +Client key path + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID to get power sequence for + +\<*NODE_ID*\> +Node ID to get firmware inventory for + +## Examples + +```sh +nico-admin-cli rms firmware-inventory rack-1 node-1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rms/rms-inventory.md b/docs/manuals/nico-admin-cli/commands/rms/rms-inventory.md new file mode 100644 index 0000000000..ca6fafb7d5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rms/rms-inventory.md @@ -0,0 +1,55 @@ +# `nico-admin-cli rms inventory` + +_[Hardware commands](../../hardware.md) › [rms](./rms.md) › **inventory**_ + +## NAME + +nico-admin-cli-rms-inventory - Get the full RMS inventory + +## SYNOPSIS + +**nico-admin-cli rms inventory** \[**--url**\] \[**--root-ca**\] +\[**--client-cert**\] \[**--client-key**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get the full RMS inventory + +## OPTIONS + +**--url** *\* +URL of RMS API endpoint (required). + +**--root-ca** *\* +Root CA path + +**--client-cert** *\* +Client certificate path + +**--client-key** *\* +Client key path + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rms/rms-power-on-sequence.md b/docs/manuals/nico-admin-cli/commands/rms/rms-power-on-sequence.md new file mode 100644 index 0000000000..8026da00b4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rms/rms-power-on-sequence.md @@ -0,0 +1,64 @@ +# `nico-admin-cli rms power-on-sequence` + +_[Hardware commands](../../hardware.md) › [rms](./rms.md) › **power-on-sequence**_ + +## NAME + +nico-admin-cli-rms-power-on-sequence - Get the power on sequence + +## SYNOPSIS + +**nico-admin-cli rms power-on-sequence** \[**--url**\] \[**--root-ca**\] +\[**--client-cert**\] \[**--client-key**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK_ID*\> + +## DESCRIPTION + +Get the power on sequence + +## OPTIONS + +**--url** *\* +URL of RMS API endpoint (required). + +**--root-ca** *\* +Root CA path + +**--client-cert** *\* +Client certificate path + +**--client-key** *\* +Client key path + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID to get power sequence for + +## Examples + +```sh +nico-admin-cli rms power-on-sequence rack-1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rms/rms-power-state.md b/docs/manuals/nico-admin-cli/commands/rms/rms-power-state.md new file mode 100644 index 0000000000..4cb2dba566 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rms/rms-power-state.md @@ -0,0 +1,67 @@ +# `nico-admin-cli rms power-state` + +_[Hardware commands](../../hardware.md) › [rms](./rms.md) › **power-state**_ + +## NAME + +nico-admin-cli-rms-power-state - Get the power state for a given node + +## SYNOPSIS + +**nico-admin-cli rms power-state** \[**--url**\] \[**--root-ca**\] +\[**--client-cert**\] \[**--client-key**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*RACK_ID*\> \<*NODE_ID*\> + +## DESCRIPTION + +Get the power state for a given node + +## OPTIONS + +**--url** *\* +URL of RMS API endpoint (required). + +**--root-ca** *\* +Root CA path + +**--client-cert** *\* +Client certificate path + +**--client-key** *\* +Client key path + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*RACK_ID*\> +Rack ID to get power sequence for + +\<*NODE_ID*\> +Node ID to get power state for + +## Examples + +```sh +nico-admin-cli rms power-state rack-1 node-1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/rms/rms.md b/docs/manuals/nico-admin-cli/commands/rms/rms.md new file mode 100644 index 0000000000..aad6c4dccf --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/rms/rms.md @@ -0,0 +1,72 @@ +# `nico-admin-cli rms` + +_[Hardware commands](../../hardware.md) › **rms**_ + +## NAME + +nico-admin-cli-rms - RMS Actions + +## SYNOPSIS + +**nico-admin-cli rms** \[**--url**\] \[**--root-ca**\] +\[**--client-cert**\] \[**--client-key**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +RMS Actions + +## OPTIONS + +**--url** *\* +URL of RMS API endpoint (required). + +**--root-ca** *\* +Root CA path + +**--client-cert** *\* +Client certificate path + +**--client-key** *\* +Client key path + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli rms --url https://rms.example.com:8443 inventory +nico-admin-cli rms power-on-sequence rack-1 +nico-admin-cli rms --url https://rms.example.com:8443 --root-ca /etc/rms/ca.crt --client-cert /etc/rms/client.crt --client-key /etc/rms/client.key inventory +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`inventory`](./rms-inventory.md) | Get the full RMS inventory | +| [`power-on-sequence`](./rms-power-on-sequence.md) | Get the power on sequence | +| [`power-state`](./rms-power-state.md) | Get the power state for a given node | +| [`firmware-inventory`](./rms-firmware-inventory.md) | Get the firmware inventory for a given node | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/route-server/route-server-add.md b/docs/manuals/nico-admin-cli/commands/route-server/route-server-add.md new file mode 100644 index 0000000000..cc385b9ca4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/route-server/route-server-add.md @@ -0,0 +1,62 @@ +# `nico-admin-cli route-server add` + +_[Network commands](../../network.md) › [route-server](./route-server.md) › **add**_ + +## NAME + +nico-admin-cli-route-server-add - Add route server addresses + +## SYNOPSIS + +**nico-admin-cli route-server add** \[**--source-type**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*IP*\] + +## DESCRIPTION + +Add route server addresses + +## OPTIONS + +**--source-type** *\* \[default: admin_api\] +The source_type to use for the target addresses. Defaults to admin_api.\ + +\ +*Possible values:* + +- admin_api + +- config_file + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IP*\] +Comma-separated list of IP addresses + +## Examples + +```sh +nico-admin-cli route-server add 10.0.0.1,10.0.0.2 +nico-admin-cli route-server add 10.0.0.1 --source-type config_file +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/route-server/route-server-get.md b/docs/manuals/nico-admin-cli/commands/route-server/route-server-get.md new file mode 100644 index 0000000000..45fd300645 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/route-server/route-server-get.md @@ -0,0 +1,48 @@ +# `nico-admin-cli route-server get` + +_[Network commands](../../network.md) › [route-server](./route-server.md) › **get**_ + +## NAME + +nico-admin-cli-route-server-get - Get all route servers + +## SYNOPSIS + +**nico-admin-cli route-server get** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Get all route servers + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli route-server get +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/route-server/route-server-remove.md b/docs/manuals/nico-admin-cli/commands/route-server/route-server-remove.md new file mode 100644 index 0000000000..59e4a15831 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/route-server/route-server-remove.md @@ -0,0 +1,62 @@ +# `nico-admin-cli route-server remove` + +_[Network commands](../../network.md) › [route-server](./route-server.md) › **remove**_ + +## NAME + +nico-admin-cli-route-server-remove - Remove route server addresses + +## SYNOPSIS + +**nico-admin-cli route-server remove** \[**--source-type**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*IP*\] + +## DESCRIPTION + +Remove route server addresses + +## OPTIONS + +**--source-type** *\* \[default: admin_api\] +The source_type to use for the target addresses. Defaults to admin_api.\ + +\ +*Possible values:* + +- admin_api + +- config_file + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IP*\] +Comma-separated list of IP addresses + +## Examples + +```sh +nico-admin-cli route-server remove 10.0.0.1,10.0.0.2 +nico-admin-cli route-server remove 10.0.0.1 --source-type config_file +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/route-server/route-server-replace.md b/docs/manuals/nico-admin-cli/commands/route-server/route-server-replace.md new file mode 100644 index 0000000000..217078c22d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/route-server/route-server-replace.md @@ -0,0 +1,61 @@ +# `nico-admin-cli route-server replace` + +_[Network commands](../../network.md) › [route-server](./route-server.md) › **replace**_ + +## NAME + +nico-admin-cli-route-server-replace - Replace all route server addresses + +## SYNOPSIS + +**nico-admin-cli route-server replace** \[**--source-type**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*IP*\] + +## DESCRIPTION + +Replace all route server addresses + +## OPTIONS + +**--source-type** *\* \[default: admin_api\] +The source_type to use for the target addresses. Defaults to admin_api.\ + +\ +*Possible values:* + +- admin_api + +- config_file + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*IP*\] +Comma-separated list of IP addresses + +## Examples + +```sh +nico-admin-cli route-server replace 10.0.0.1,10.0.0.2,10.0.0.3 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/route-server/route-server.md b/docs/manuals/nico-admin-cli/commands/route-server/route-server.md new file mode 100644 index 0000000000..0e6d3263fc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/route-server/route-server.md @@ -0,0 +1,51 @@ +# `nico-admin-cli route-server` + +_[Network commands](../../network.md) › **route-server**_ + +## NAME + +nico-admin-cli-route-server - Route server handling + +## SYNOPSIS + +**nico-admin-cli route-server** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Route server handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`get`](./route-server-get.md) | Get all route servers | +| [`add`](./route-server-add.md) | Add route server addresses | +| [`remove`](./route-server-remove.md) | Remove route server addresses | +| [`replace`](./route-server-replace.md) | Replace all route server addresses | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-disconnect.md b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-disconnect.md new file mode 100644 index 0000000000..e97a0d3454 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-disconnect.md @@ -0,0 +1,51 @@ +# `nico-admin-cli scout-stream disconnect` + +_[Hardware commands](../../hardware.md) › [scout-stream](./scout-stream.md) › **disconnect**_ + +## NAME + +nico-admin-cli-scout-stream-disconnect - Disconnect a scout stream +connection + +## SYNOPSIS + +**nico-admin-cli scout-stream disconnect** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Disconnect a scout stream connection + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +## Examples + +```sh +nico-admin-cli scout-stream disconnect 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-ping.md b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-ping.md new file mode 100644 index 0000000000..96af7bd8fd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-ping.md @@ -0,0 +1,51 @@ +# `nico-admin-cli scout-stream ping` + +_[Hardware commands](../../hardware.md) › [scout-stream](./scout-stream.md) › **ping**_ + +## NAME + +nico-admin-cli-scout-stream-ping - Ping test for a scout stream +connection + +## SYNOPSIS + +**nico-admin-cli scout-stream ping** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Ping test for a scout stream connection + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +## Examples + +```sh +nico-admin-cli scout-stream ping 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-show.md b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-show.md new file mode 100644 index 0000000000..cafac09479 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream-show.md @@ -0,0 +1,49 @@ +# `nico-admin-cli scout-stream show` + +_[Hardware commands](../../hardware.md) › [scout-stream](./scout-stream.md) › **show**_ + +## NAME + +nico-admin-cli-scout-stream-show - Show all active scout stream +connections + +## SYNOPSIS + +**nico-admin-cli scout-stream show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show all active scout stream connections + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli scout-stream show +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream.md b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream.md new file mode 100644 index 0000000000..4a5ff0426a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/scout-stream/scout-stream.md @@ -0,0 +1,50 @@ +# `nico-admin-cli scout-stream` + +_[Hardware commands](../../hardware.md) › **scout-stream**_ + +## NAME + +nico-admin-cli-scout-stream - Scout Stream Connection Handling + +## SYNOPSIS + +**nico-admin-cli scout-stream** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Scout Stream Connection Handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./scout-stream-show.md) | Show all active scout stream connections | +| [`disconnect`](./scout-stream-disconnect.md) | Disconnect a scout stream connection | +| [`ping`](./scout-stream-ping.md) | Ping test for a scout stream connection | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/set/set-bmc-proxy.md b/docs/manuals/nico-admin-cli/commands/set/set-bmc-proxy.md new file mode 100644 index 0000000000..2b2dafc43c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/set/set-bmc-proxy.md @@ -0,0 +1,62 @@ +# `nico-admin-cli set bmc-proxy` + +_[Hardware commands](../../hardware.md) › [set](./set.md) › **bmc-proxy**_ + +## NAME + +nico-admin-cli-set-bmc-proxy - Set bmc_proxy + +## SYNOPSIS + +**nico-admin-cli set bmc-proxy** \<**--enabled**\> \[**--proxy**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Set bmc_proxy + +## OPTIONS + +**--enabled** *\* +Enable site-explorer bmc_proxy\ + +\ +*Possible values:* + +- true + +- false + +**--proxy** *\* +host:port string use as a proxy for talking to BMCs + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli set bmc-proxy --enabled true --proxy 192.0.2.10:8080 +nico-admin-cli set bmc-proxy --enabled false +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/set/set-create-machines.md b/docs/manuals/nico-admin-cli/commands/set/set-create-machines.md new file mode 100644 index 0000000000..646e052391 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/set/set-create-machines.md @@ -0,0 +1,56 @@ +# `nico-admin-cli set create-machines` + +_[Hardware commands](../../hardware.md) › [set](./set.md) › **create-machines**_ + +## NAME + +nico-admin-cli-set-create-machines - Set create_machines + +## SYNOPSIS + +**nico-admin-cli set create-machines** \[**--enable**\] +\[**--disable**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Set create_machines + +## OPTIONS + +**--enable** +Enable machine creation + +**--disable** +Disable machine creation + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli set create-machines --enable +nico-admin-cli set create-machines --disable +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/set/set-log-filter.md b/docs/manuals/nico-admin-cli/commands/set/set-log-filter.md new file mode 100644 index 0000000000..9cea37e637 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/set/set-log-filter.md @@ -0,0 +1,57 @@ +# `nico-admin-cli set log-filter` + +_[Hardware commands](../../hardware.md) › [set](./set.md) › **log-filter**_ + +## NAME + +nico-admin-cli-set-log-filter - Set RUST_LOG + +## SYNOPSIS + +**nico-admin-cli set log-filter** \<**-f**\|**--filter**\> +\[**--expiry**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Set RUST_LOG + +## OPTIONS + +**-f**, **--filter** *\* +Set servers RUST_LOG. + +**--expiry** *\* \[default: 1h\] +Revert to startup RUST_LOG after this much time, friendly format e.g. +1h, 3min, https://docs.rs/duration-str/latest/duration_str/ + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli set log-filter --filter debug +nico-admin-cli set log-filter --filter carbide_api=trace,info --expiry 30min +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/set/set-site-explorer.md b/docs/manuals/nico-admin-cli/commands/set/set-site-explorer.md new file mode 100644 index 0000000000..f95a1cd474 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/set/set-site-explorer.md @@ -0,0 +1,55 @@ +# `nico-admin-cli set site-explorer` + +_[Hardware commands](../../hardware.md) › [set](./set.md) › **site-explorer**_ + +## NAME + +nico-admin-cli-set-site-explorer - Enable or disable site-explorer + +## SYNOPSIS + +**nico-admin-cli set site-explorer** \[**--enable**\] \[**--disable**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Enable or disable site-explorer + +## OPTIONS + +**--enable** +Enable site-explorer + +**--disable** +Disable site-explorer + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli set site-explorer --enable +nico-admin-cli set site-explorer --disable +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/set/set-tracing-enabled.md b/docs/manuals/nico-admin-cli/commands/set/set-tracing-enabled.md new file mode 100644 index 0000000000..c04d0436f2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/set/set-tracing-enabled.md @@ -0,0 +1,59 @@ +# `nico-admin-cli set tracing-enabled` + +_[Hardware commands](../../hardware.md) › [set](./set.md) › **tracing-enabled**_ + +## NAME + +nico-admin-cli-set-tracing-enabled - Configure whether trace/span +information is sent to an OTLP endpoint like Tempo + +## SYNOPSIS + +**nico-admin-cli set tracing-enabled** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*true\|false*\> + +## DESCRIPTION + +Configure whether trace/span information is sent to an OTLP endpoint +like Tempo + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*true\|false*\> +\ +*Possible values:* + +- true + +- false + +## Examples + +```sh +nico-admin-cli set tracing-enabled true +nico-admin-cli set tracing-enabled false +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/set/set.md b/docs/manuals/nico-admin-cli/commands/set/set.md new file mode 100644 index 0000000000..840bcd1d13 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/set/set.md @@ -0,0 +1,52 @@ +# `nico-admin-cli set` + +_[Hardware commands](../../hardware.md) › **set**_ + +## NAME + +nico-admin-cli-set - Set carbide-api dynamic features + +## SYNOPSIS + +**nico-admin-cli set** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Set carbide-api dynamic features + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`log-filter`](./set-log-filter.md) | Set RUST_LOG | +| [`create-machines`](./set-create-machines.md) | Set create_machines | +| [`site-explorer`](./set-site-explorer.md) | Enable or disable site-explorer | +| [`bmc-proxy`](./set-bmc-proxy.md) | Set bmc_proxy | +| [`tracing-enabled`](./set-tracing-enabled.md) | Configure whether trace/span information is sent to an OTLP endpoint like Tempo | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-clear-error.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-clear-error.md new file mode 100644 index 0000000000..cf82886968 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-clear-error.md @@ -0,0 +1,57 @@ +# `nico-admin-cli site-explorer clear-error` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **clear-error**_ + +## NAME + +nico-admin-cli-site-explorer-clear-error - Clear the last known error +for the BMC in the latest site exploration report. + +## SYNOPSIS + +**nico-admin-cli site-explorer clear-error** \[**--mac**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*ADDRESS*\> + +## DESCRIPTION + +Clear the last known error for the BMC in the latest site exploration +report. + +## OPTIONS + +**--mac** *\* +The MAC address the BMC sent DHCP from + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address or hostname with optional port + +## Examples + +```sh +nico-admin-cli site-explorer clear-error 192.0.2.10 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-copy-bfb-to-dpu-rshim.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-copy-bfb-to-dpu-rshim.md new file mode 100644 index 0000000000..5a6ed707e3 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-copy-bfb-to-dpu-rshim.md @@ -0,0 +1,62 @@ +# `nico-admin-cli site-explorer copy-bfb-to-dpu-rshim` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **copy-bfb-to-dpu-rshim**_ + +## NAME + +nico-admin-cli-site-explorer-copy-bfb-to-dpu-rshim + +## SYNOPSIS + +**nico-admin-cli site-explorer copy-bfb-to-dpu-rshim** \[**--mac**\] +\<**--host-bmc-ip**\> \[**--pre-copy-powercycle**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*ADDRESS*\> + +## DESCRIPTION + +## OPTIONS + +**--mac** *\* +The MAC address the BMC sent DHCP from + +**--host-bmc-ip** *\* +Host BMC IP address. Required for the mandatory post-copy host +power-cycle that applies the new BFB image to the DPU. + +**--pre-copy-powercycle** +Power-cycle the host before the BFB copy to release rshim control to the +DPU BMC. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address or hostname with optional port + +## Examples + +```sh +nico-admin-cli site-explorer copy-bfb-to-dpu-rshim 192.0.2.10 --host-bmc-ip 192.0.2.20 +nico-admin-cli site-explorer copy-bfb-to-dpu-rshim 192.0.2.10 --host-bmc-ip 192.0.2.20 --pre-copy-powercycle +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-delete.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-delete.md new file mode 100644 index 0000000000..64f36b82c1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-delete.md @@ -0,0 +1,52 @@ +# `nico-admin-cli site-explorer delete` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **delete**_ + +## NAME + +nico-admin-cli-site-explorer-delete - Delete an explored endpoint from +the database. + +## SYNOPSIS + +**nico-admin-cli site-explorer delete** \<**--address**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete an explored endpoint from the database. + +## OPTIONS + +**--address** *\* +BMC IP address of the endpoint to delete + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli site-explorer delete --address 192.0.2.10 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-explore.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-explore.md new file mode 100644 index 0000000000..51c64ca335 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-explore.md @@ -0,0 +1,58 @@ +# `nico-admin-cli site-explorer explore` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **explore**_ + +## NAME + +nico-admin-cli-site-explorer-explore - Asks carbide-api to explore a +single host and prints the report. Does not store it. + +## SYNOPSIS + +**nico-admin-cli site-explorer explore** \[**--mac**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*ADDRESS*\> + +## DESCRIPTION + +Asks carbide-api to explore a single host and prints the report. Does +not store it. + +## OPTIONS + +**--mac** *\* +The MAC address the BMC sent DHCP from + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address or hostname with optional port + +## Examples + +```sh +nico-admin-cli site-explorer explore 192.0.2.10 +nico-admin-cli site-explorer explore 192.0.2.10 --mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-all.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-all.md new file mode 100644 index 0000000000..89277ba906 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-all.md @@ -0,0 +1,42 @@ +# `nico-admin-cli site-explorer get-report all` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › [get-report](./site-explorer-get-report.md) › **all**_ + +## NAME + +nico-admin-cli-site-explorer-get-report-all - Get everything in Json + +## SYNOPSIS + +**nico-admin-cli site-explorer get-report all** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Get everything in Json + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-endpoint.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-endpoint.md new file mode 100644 index 0000000000..4a8c0ef797 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-endpoint.md @@ -0,0 +1,69 @@ +# `nico-admin-cli site-explorer get-report endpoint` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › [get-report](./site-explorer-get-report.md) › **endpoint**_ + +## NAME + +nico-admin-cli-site-explorer-get-report-endpoint - Get Endpoint details. + +## SYNOPSIS + +**nico-admin-cli site-explorer get-report endpoint** +\[**-v**\|**--vendor**\] \[**--unpairedonly**\] \[**--erroronly**\] +\[**--successonly**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*ADDRESS*\] + +## DESCRIPTION + +Get Endpoint details. + +## OPTIONS + +**-v**, **--vendor** *\* +Filter based on vendor. Valid only for table view. + +**--unpairedonly** +By default shows all endpoints. If wants to see unpairedonly, choose +this option. + +**--erroronly** +Show only endpoints which have error. + +**--successonly** +Show only endpoints which have no error. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ADDRESS*\] +BMC IP address of Endpoint. + +## Examples + +```sh +nico-admin-cli site-explorer get-report endpoint +nico-admin-cli site-explorer get-report endpoint 192.0.2.10 +nico-admin-cli site-explorer get-report endpoint --erroronly --vendor nvidia +nico-admin-cli site-explorer get-report endpoint --unpairedonly +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-managed-host.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-managed-host.md new file mode 100644 index 0000000000..8ae3e4875e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report-managed-host.md @@ -0,0 +1,58 @@ +# `nico-admin-cli site-explorer get-report managed-host` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › [get-report](./site-explorer-get-report.md) › **managed-host**_ + +## NAME + +nico-admin-cli-site-explorer-get-report-managed-host - Get discovered +host details. + +## SYNOPSIS + +**nico-admin-cli site-explorer get-report managed-host** +\[**-v**\|**--vendor**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*ADDRESS*\] + +## DESCRIPTION + +Get discovered host details. + +## OPTIONS + +**-v**, **--vendor** *\* +Filter based on vendor. Valid only for table view. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ADDRESS*\] +BMC IP address of host or DPU + +## Examples + +```sh +nico-admin-cli site-explorer get-report managed-host +nico-admin-cli site-explorer get-report managed-host 192.0.2.10 +nico-admin-cli site-explorer get-report managed-host --vendor nvidia +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report.md new file mode 100644 index 0000000000..63255bfd15 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-get-report.md @@ -0,0 +1,59 @@ +# `nico-admin-cli site-explorer get-report` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **get-report**_ + +## NAME + +nico-admin-cli-site-explorer-get-report - Retrieves the latest site +exploration report + +## SYNOPSIS + +**nico-admin-cli site-explorer get-report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Retrieves the latest site exploration report + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli site-explorer get-report all +nico-admin-cli site-explorer get-report managed-host +nico-admin-cli site-explorer get-report endpoint +``` + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`all`](./site-explorer-get-report-all.md) | Get everything in Json | +| [`managed-host`](./site-explorer-get-report-managed-host.md) | Get discovered host details. | +| [`endpoint`](./site-explorer-get-report-endpoint.md) | Get Endpoint details. | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-have-credentials.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-have-credentials.md new file mode 100644 index 0000000000..535c1e47b6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-have-credentials.md @@ -0,0 +1,53 @@ +# `nico-admin-cli site-explorer have-credentials` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **have-credentials**_ + +## NAME + +nico-admin-cli-site-explorer-have-credentials + +## SYNOPSIS + +**nico-admin-cli site-explorer have-credentials** \[**--mac**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*ADDRESS*\> + +## DESCRIPTION + +## OPTIONS + +**--mac** *\* +The MAC address the BMC sent DHCP from + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address or hostname with optional port + +## Examples + +```sh +nico-admin-cli site-explorer have-credentials 192.0.2.10 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-is-bmc-in-managed-host.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-is-bmc-in-managed-host.md new file mode 100644 index 0000000000..9fd49a26d1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-is-bmc-in-managed-host.md @@ -0,0 +1,53 @@ +# `nico-admin-cli site-explorer is-bmc-in-managed-host` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **is-bmc-in-managed-host**_ + +## NAME + +nico-admin-cli-site-explorer-is-bmc-in-managed-host + +## SYNOPSIS + +**nico-admin-cli site-explorer is-bmc-in-managed-host** \[**--mac**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] +\<*ADDRESS*\> + +## DESCRIPTION + +## OPTIONS + +**--mac** *\* +The MAC address the BMC sent DHCP from + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address or hostname with optional port + +## Examples + +```sh +nico-admin-cli site-explorer is-bmc-in-managed-host 192.0.2.10 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-re-explore.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-re-explore.md new file mode 100644 index 0000000000..37d8bfe86b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-re-explore.md @@ -0,0 +1,53 @@ +# `nico-admin-cli site-explorer re-explore` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **re-explore**_ + +## NAME + +nico-admin-cli-site-explorer-re-explore - Asks carbide-api to explore a +single host in the next exploration cycle. The results will be stored. + +## SYNOPSIS + +**nico-admin-cli site-explorer re-explore** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*ADDRESS*\> + +## DESCRIPTION + +Asks carbide-api to explore a single host in the next exploration cycle. +The results will be stored. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address + +## Examples + +```sh +nico-admin-cli site-explorer re-explore 192.0.2.10 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-refresh.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-refresh.md new file mode 100644 index 0000000000..b0964f0079 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-refresh.md @@ -0,0 +1,52 @@ +# `nico-admin-cli site-explorer refresh` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **refresh**_ + +## NAME + +nico-admin-cli-site-explorer-refresh - Immediately probes a BMC endpoint +and persists the report. + +## SYNOPSIS + +**nico-admin-cli site-explorer refresh** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*ADDRESS*\> + +## DESCRIPTION + +Immediately probes a BMC endpoint and persists the report. + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address + +## Examples + +```sh +nico-admin-cli site-explorer refresh 192.0.2.10 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-remediation.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-remediation.md new file mode 100644 index 0000000000..4f6fa5ce6f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-remediation.md @@ -0,0 +1,60 @@ +# `nico-admin-cli site-explorer remediation` + +_[Tenant commands](../../tenant.md) › [site-explorer](./site-explorer.md) › **remediation**_ + +## NAME + +nico-admin-cli-site-explorer-remediation - Control remediation actions +for an explored endpoint. + +## SYNOPSIS + +**nico-admin-cli site-explorer remediation** \[**--pause**\] +\[**--resume**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*ADDRESS*\> + +## DESCRIPTION + +Control remediation actions for an explored endpoint. + +## OPTIONS + +**--pause** +Pause remediation actions + +**--resume** +Resume remediation actions + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ADDRESS*\> +BMC IP address of the endpoint + +## Examples + +```sh +nico-admin-cli site-explorer remediation 192.0.2.10 --pause +nico-admin-cli site-explorer remediation 192.0.2.10 --resume +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer.md b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer.md new file mode 100644 index 0000000000..700ef1f43b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/site-explorer/site-explorer.md @@ -0,0 +1,57 @@ +# `nico-admin-cli site-explorer` + +_[Tenant commands](../../tenant.md) › **site-explorer**_ + +## NAME + +nico-admin-cli-site-explorer - Site explorer functions + +## SYNOPSIS + +**nico-admin-cli site-explorer** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Site explorer functions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`get-report`](./site-explorer-get-report.md) | Retrieves the latest site exploration report | +| [`explore`](./site-explorer-explore.md) | Asks carbide-api to explore a single host and prints the report. Does not store it. | +| [`re-explore`](./site-explorer-re-explore.md) | Asks carbide-api to explore a single host in the next exploration cycle. The results will be stored. | +| [`refresh`](./site-explorer-refresh.md) | Immediately probes a BMC endpoint and persists the report. | +| [`clear-error`](./site-explorer-clear-error.md) | Clear the last known error for the BMC in the latest site exploration report. | +| [`delete`](./site-explorer-delete.md) | Delete an explored endpoint from the database. | +| [`remediation`](./site-explorer-remediation.md) | Control remediation actions for an explored endpoint. | +| [`is-bmc-in-managed-host`](./site-explorer-is-bmc-in-managed-host.md) | | +| [`have-credentials`](./site-explorer-have-credentials.md) | | +| [`copy-bfb-to-dpu-rshim`](./site-explorer-copy-bfb-to-dpu-rshim.md) | | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-assign.md b/docs/manuals/nico-admin-cli/commands/sku/sku-assign.md new file mode 100644 index 0000000000..990e1c6f7d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-assign.md @@ -0,0 +1,53 @@ +# `nico-admin-cli sku assign` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **assign**_ + +## NAME + +nico-admin-cli-sku-assign - Assign a SKU to a machine + +## SYNOPSIS + +**nico-admin-cli sku assign** \[**--force**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*SKU_ID*\> \<*MACHINE_ID*\> + +## DESCRIPTION + +Assign a SKU to a machine + +## OPTIONS + +**--force** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SKU_ID*\> +\<*MACHINE_ID*\> + +## Examples + +```sh +nico-admin-cli sku assign DGX-H100-640GB 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli sku assign DGX-H100-640GB 12345678-1234-5678-90ab-cdef01234567 --force +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-bulk-update-metadata.md b/docs/manuals/nico-admin-cli/commands/sku/sku-bulk-update-metadata.md new file mode 100644 index 0000000000..ad932a9040 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-bulk-update-metadata.md @@ -0,0 +1,52 @@ +# `nico-admin-cli sku bulk-update-metadata` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **bulk-update-metadata**_ + +## NAME + +nico-admin-cli-sku-bulk-update-metadata - Update multiple SKUs metadata +from a file + +## SYNOPSIS + +**nico-admin-cli sku bulk-update-metadata** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*FILENAME*\> + +## DESCRIPTION + +Update multiple SKUs metadata from a file + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*FILENAME*\> +The CSV file to use to update metadata for multiple skus + +## Examples + +```sh +nico-admin-cli sku bulk-update-metadata ./sku-metadata.csv +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-create.md b/docs/manuals/nico-admin-cli/commands/sku/sku-create.md new file mode 100644 index 0000000000..8efbdd8afa --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-create.md @@ -0,0 +1,55 @@ +# `nico-admin-cli sku create` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **create**_ + +## NAME + +nico-admin-cli-sku-create - Create SKUs from a file + +## SYNOPSIS + +**nico-admin-cli sku create** \[**--id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*FILENAME*\> + +## DESCRIPTION + +Create SKUs from a file + +## OPTIONS + +**--id** *\* +override the ID of the SKU in the file data + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*FILENAME*\> +The filename of the SKU data + +## Examples + +```sh +nico-admin-cli sku create ./skus.json +nico-admin-cli sku create ./skus.json --id DGX-H100-640GB +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-delete.md b/docs/manuals/nico-admin-cli/commands/sku/sku-delete.md new file mode 100644 index 0000000000..64a5ede040 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-delete.md @@ -0,0 +1,50 @@ +# `nico-admin-cli sku delete` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **delete**_ + +## NAME + +nico-admin-cli-sku-delete - Delete a SKU + +## SYNOPSIS + +**nico-admin-cli sku delete** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SKU_ID*\> + +## DESCRIPTION + +Delete a SKU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SKU_ID*\> + +## Examples + +```sh +nico-admin-cli sku delete DGX-H100-640GB +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-generate.md b/docs/manuals/nico-admin-cli/commands/sku/sku-generate.md new file mode 100644 index 0000000000..307e11d671 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-generate.md @@ -0,0 +1,56 @@ +# `nico-admin-cli sku generate` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **generate**_ + +## NAME + +nico-admin-cli-sku-generate - Generate SKU information from an existing +machine + +## SYNOPSIS + +**nico-admin-cli sku generate** \[**--id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Generate SKU information from an existing machine + +## OPTIONS + +**--id** *\* +override the ID of the SKU + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine id of the machine to use to generate a SKU + +## Examples + +```sh +nico-admin-cli sku generate 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli sku generate 12345678-1234-5678-90ab-cdef01234567 --id DGX-H100-640GB +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-replace.md b/docs/manuals/nico-admin-cli/commands/sku/sku-replace.md new file mode 100644 index 0000000000..0e71c06cb9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-replace.md @@ -0,0 +1,54 @@ +# `nico-admin-cli sku replace` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **replace**_ + +## NAME + +nico-admin-cli-sku-replace - Replace the component list of a SKU + +## SYNOPSIS + +**nico-admin-cli sku replace** \[**--id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*FILENAME*\> + +## DESCRIPTION + +Replace the component list of a SKU + +## OPTIONS + +**--id** *\* +override the ID of the SKU in the file data + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*FILENAME*\> +The filename of the SKU data + +## Examples + +```sh +nico-admin-cli sku replace ./skus.json --id DGX-H100-640GB +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-show-machines.md b/docs/manuals/nico-admin-cli/commands/sku/sku-show-machines.md new file mode 100644 index 0000000000..ee3074f917 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-show-machines.md @@ -0,0 +1,51 @@ +# `nico-admin-cli sku show-machines` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **show-machines**_ + +## NAME + +nico-admin-cli-sku-show-machines - Show what machines are assigned a SKU + +## SYNOPSIS + +**nico-admin-cli sku show-machines** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*SKU_ID*\] + +## DESCRIPTION + +Show what machines are assigned a SKU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*SKU_ID*\] +Show SKU details + +## Examples + +```sh +nico-admin-cli sku show-machines DGX-H100-640GB +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-show.md b/docs/manuals/nico-admin-cli/commands/sku/sku-show.md new file mode 100644 index 0000000000..cba8fde5ab --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli sku show` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **show**_ + +## NAME + +nico-admin-cli-sku-show - Show SKU information + +## SYNOPSIS + +**nico-admin-cli sku show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*SKU_ID*\] + +## DESCRIPTION + +Show SKU information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*SKU_ID*\] +Show SKU details + +## Examples + +```sh +nico-admin-cli sku show +nico-admin-cli sku show DGX-H100-640GB +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-unassign.md b/docs/manuals/nico-admin-cli/commands/sku/sku-unassign.md new file mode 100644 index 0000000000..d5a0d37616 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-unassign.md @@ -0,0 +1,53 @@ +# `nico-admin-cli sku unassign` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **unassign**_ + +## NAME + +nico-admin-cli-sku-unassign - Unassign a SKU from a machine + +## SYNOPSIS + +**nico-admin-cli sku unassign** \[**--force**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Unassign a SKU from a machine + +## OPTIONS + +**--force** +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> +The machine id of the machine to unassign + +## Examples + +```sh +nico-admin-cli sku unassign 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli sku unassign 12345678-1234-5678-90ab-cdef01234567 --force +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-update-metadata.md b/docs/manuals/nico-admin-cli/commands/sku/sku-update-metadata.md new file mode 100644 index 0000000000..2e4d4a99da --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-update-metadata.md @@ -0,0 +1,60 @@ +# `nico-admin-cli sku update-metadata` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **update-metadata**_ + +## NAME + +nico-admin-cli-sku-update-metadata - Update the metadata of a SKU + +## SYNOPSIS + +**nico-admin-cli sku update-metadata** \[**--description**\] +\[**--device-type**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SKU_ID*\> + +## DESCRIPTION + +Update the metadata of a SKU + +## OPTIONS + +**--description** *\* +Update the SKUs description + +**--device-type** *\* +Update the SKUs device type + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SKU_ID*\> +SKU ID of the SKU to update + +## Examples + +```sh +nico-admin-cli sku update-metadata DGX-H100-640GB --description "DGX H100 640GB" +nico-admin-cli sku update-metadata DGX-H100-640GB --device-type gpu-server +nico-admin-cli sku update-metadata DGX-H100-640GB --description "DGX H100 640GB" --device-type gpu-server +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku-verify.md b/docs/manuals/nico-admin-cli/commands/sku/sku-verify.md new file mode 100644 index 0000000000..2367e5f4dd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku-verify.md @@ -0,0 +1,50 @@ +# `nico-admin-cli sku verify` + +_[Hardware commands](../../hardware.md) › [sku](./sku.md) › **verify**_ + +## NAME + +nico-admin-cli-sku-verify - Verify a machine against its SKU + +## SYNOPSIS + +**nico-admin-cli sku verify** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*MACHINE_ID*\> + +## DESCRIPTION + +Verify a machine against its SKU + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*MACHINE_ID*\> + +## Examples + +```sh +nico-admin-cli sku verify 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/sku/sku.md b/docs/manuals/nico-admin-cli/commands/sku/sku.md new file mode 100644 index 0000000000..92f60a5485 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/sku/sku.md @@ -0,0 +1,58 @@ +# `nico-admin-cli sku` + +_[Hardware commands](../../hardware.md) › **sku**_ + +## NAME + +nico-admin-cli-sku - Manage machine SKUs + +## SYNOPSIS + +**nico-admin-cli sku** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage machine SKUs + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./sku-show.md) | Show SKU information | +| [`show-machines`](./sku-show-machines.md) | Show what machines are assigned a SKU | +| [`generate`](./sku-generate.md) | Generate SKU information from an existing machine | +| [`create`](./sku-create.md) | Create SKUs from a file | +| [`delete`](./sku-delete.md) | Delete a SKU | +| [`assign`](./sku-assign.md) | Assign a SKU to a machine | +| [`unassign`](./sku-unassign.md) | Unassign a SKU from a machine | +| [`verify`](./sku-verify.md) | Verify a machine against its SKU | +| [`update-metadata`](./sku-update-metadata.md) | Update the metadata of a SKU | +| [`bulk-update-metadata`](./sku-bulk-update-metadata.md) | Update multiple SKU's metadata from a file | +| [`replace`](./sku-replace.md) | Replace the component list of a SKU | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/spx-partition/spx-partition-show.md b/docs/manuals/nico-admin-cli/commands/spx-partition/spx-partition-show.md new file mode 100644 index 0000000000..f860de90a1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/spx-partition/spx-partition-show.md @@ -0,0 +1,62 @@ +# `nico-admin-cli spx-partition show` + +_[Network commands](../../network.md) › [spx-partition](./spx-partition.md) › **show**_ + +## NAME + +nico-admin-cli-spx-partition-show - Display SpectrumX Partition +information + +## SYNOPSIS + +**nico-admin-cli spx-partition show** \[**-t**\|**--tenant-org-id**\] +\[**-n**\|**--name**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display SpectrumX Partition information + +## OPTIONS + +**-t**, **--tenant-org-id** *\* +The Tenant Org ID to query + +**-n**, **--name** *\* +The SPX Partition name to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +The SPX Partition ID to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli spx-partition show +nico-admin-cli spx-partition show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli spx-partition show --tenant-org-id fds34511233a +nico-admin-cli spx-partition show --name my-partition +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/spx-partition/spx-partition.md b/docs/manuals/nico-admin-cli/commands/spx-partition/spx-partition.md new file mode 100644 index 0000000000..8797fd3773 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/spx-partition/spx-partition.md @@ -0,0 +1,48 @@ +# `nico-admin-cli spx-partition` + +_[Network commands](../../network.md) › **spx-partition**_ + +## NAME + +nico-admin-cli-spx-partition - SPX Partition related handling + +## SYNOPSIS + +**nico-admin-cli spx-partition** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +SPX Partition related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./spx-partition-show.md) | Display SpectrumX Partition information | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ssh/ssh-copy-bfb.md b/docs/manuals/nico-admin-cli/commands/ssh/ssh-copy-bfb.md new file mode 100644 index 0000000000..c267ce3413 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ssh/ssh-copy-bfb.md @@ -0,0 +1,61 @@ +# `nico-admin-cli ssh copy-bfb` + +_[Admin commands](../../admin.md) › [ssh](./ssh.md) › **copy-bfb**_ + +## NAME + +nico-admin-cli-ssh-copy-bfb - Copy BFB to the DPU BMCs RSHIM + +## SYNOPSIS + +**nico-admin-cli ssh copy-bfb** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*BMC_IP_ADDRESS*\> \<*BMC_USERNAME*\> +\<*BMC_PASSWORD*\> \<*BFB_PATH*\> + +## DESCRIPTION + +Copy BFB to the DPU BMCs RSHIM + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*BMC_IP_ADDRESS*\> +BMC IP Address + +\<*BMC_USERNAME*\> +BMC Username + +\<*BMC_PASSWORD*\> +BMC Password + +\<*BFB_PATH*\> +BFB Path + +## Examples + +```sh +nico-admin-cli ssh copy-bfb 192.0.2.10:22 admin mypassword /path/to/image.bfb +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ssh/ssh-disable-rshim.md b/docs/manuals/nico-admin-cli/commands/ssh/ssh-disable-rshim.md new file mode 100644 index 0000000000..c012dbe8a5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ssh/ssh-disable-rshim.md @@ -0,0 +1,58 @@ +# `nico-admin-cli ssh disable-rshim` + +_[Admin commands](../../admin.md) › [ssh](./ssh.md) › **disable-rshim**_ + +## NAME + +nico-admin-cli-ssh-disable-rshim - Disable Rshim + +## SYNOPSIS + +**nico-admin-cli ssh disable-rshim** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*BMC_IP_ADDRESS*\> +\<*BMC_USERNAME*\> \<*BMC_PASSWORD*\> + +## DESCRIPTION + +Disable Rshim + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*BMC_IP_ADDRESS*\> +BMC IP Address + +\<*BMC_USERNAME*\> +BMC Username + +\<*BMC_PASSWORD*\> +BMC Password + +## Examples + +```sh +nico-admin-cli ssh disable-rshim 192.0.2.10:22 admin mypassword +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ssh/ssh-enable-rshim.md b/docs/manuals/nico-admin-cli/commands/ssh/ssh-enable-rshim.md new file mode 100644 index 0000000000..cd499c8443 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ssh/ssh-enable-rshim.md @@ -0,0 +1,58 @@ +# `nico-admin-cli ssh enable-rshim` + +_[Admin commands](../../admin.md) › [ssh](./ssh.md) › **enable-rshim**_ + +## NAME + +nico-admin-cli-ssh-enable-rshim - EnableRshim + +## SYNOPSIS + +**nico-admin-cli ssh enable-rshim** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*BMC_IP_ADDRESS*\> \<*BMC_USERNAME*\> +\<*BMC_PASSWORD*\> + +## DESCRIPTION + +EnableRshim + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*BMC_IP_ADDRESS*\> +BMC IP Address + +\<*BMC_USERNAME*\> +BMC Username + +\<*BMC_PASSWORD*\> +BMC Password + +## Examples + +```sh +nico-admin-cli ssh enable-rshim 192.0.2.10:22 admin mypassword +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ssh/ssh-get-rshim-status.md b/docs/manuals/nico-admin-cli/commands/ssh/ssh-get-rshim-status.md new file mode 100644 index 0000000000..a579e16fd1 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ssh/ssh-get-rshim-status.md @@ -0,0 +1,58 @@ +# `nico-admin-cli ssh get-rshim-status` + +_[Admin commands](../../admin.md) › [ssh](./ssh.md) › **get-rshim-status**_ + +## NAME + +nico-admin-cli-ssh-get-rshim-status - Show Rshim Status + +## SYNOPSIS + +**nico-admin-cli ssh get-rshim-status** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*BMC_IP_ADDRESS*\> +\<*BMC_USERNAME*\> \<*BMC_PASSWORD*\> + +## DESCRIPTION + +Show Rshim Status + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*BMC_IP_ADDRESS*\> +BMC IP Address + +\<*BMC_USERNAME*\> +BMC Username + +\<*BMC_PASSWORD*\> +BMC Password + +## Examples + +```sh +nico-admin-cli ssh get-rshim-status 192.0.2.10:22 admin mypassword +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ssh/ssh-show-obmc-log.md b/docs/manuals/nico-admin-cli/commands/ssh/ssh-show-obmc-log.md new file mode 100644 index 0000000000..0a7334ecea --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ssh/ssh-show-obmc-log.md @@ -0,0 +1,58 @@ +# `nico-admin-cli ssh show-obmc-log` + +_[Admin commands](../../admin.md) › [ssh](./ssh.md) › **show-obmc-log**_ + +## NAME + +nico-admin-cli-ssh-show-obmc-log - Show the DPUs BMCs OBMC log + +## SYNOPSIS + +**nico-admin-cli ssh show-obmc-log** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*BMC_IP_ADDRESS*\> +\<*BMC_USERNAME*\> \<*BMC_PASSWORD*\> + +## DESCRIPTION + +Show the DPUs BMCs OBMC log + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*BMC_IP_ADDRESS*\> +BMC IP Address + +\<*BMC_USERNAME*\> +BMC Username + +\<*BMC_PASSWORD*\> +BMC Password + +## Examples + +```sh +nico-admin-cli ssh show-obmc-log 192.0.2.10:22 admin mypassword +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/ssh/ssh.md b/docs/manuals/nico-admin-cli/commands/ssh/ssh.md new file mode 100644 index 0000000000..7ff3742cf4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/ssh/ssh.md @@ -0,0 +1,52 @@ +# `nico-admin-cli ssh` + +_[Admin commands](../../admin.md) › **ssh**_ + +## NAME + +nico-admin-cli-ssh - SSH Util functions + +## SYNOPSIS + +**nico-admin-cli ssh** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +SSH Util functions + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`get-rshim-status`](./ssh-get-rshim-status.md) | Show Rshim Status | +| [`disable-rshim`](./ssh-disable-rshim.md) | Disable Rshim | +| [`enable-rshim`](./ssh-enable-rshim.md) | EnableRshim | +| [`copy-bfb`](./ssh-copy-bfb.md) | Copy BFB to the DPU BMC's RSHIM | +| [`show-obmc-log`](./ssh-show-obmc-log.md) | Show the DPU's BMC's OBMC log | + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-force-delete.md b/docs/manuals/nico-admin-cli/commands/switch/switch-force-delete.md new file mode 100644 index 0000000000..17abb2eb5c --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-force-delete.md @@ -0,0 +1,57 @@ +# `nico-admin-cli switch force-delete` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › **force-delete**_ + +## NAME + +nico-admin-cli-switch-force-delete - Force delete a switch and +optionally its interfaces + +## SYNOPSIS + +**nico-admin-cli switch force-delete** +\[**-d**\|**--delete-interfaces**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SWITCH_ID*\> + +## DESCRIPTION + +Force delete a switch and optionally its interfaces + +## OPTIONS + +**-d**, **--delete-interfaces** +Delete machine interfaces associated with this switch. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH_ID*\> +Switch ID to force delete. + +## Examples + +```sh +nico-admin-cli switch force-delete 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli switch force-delete 12345678-1234-5678-90ab-cdef01234567 --delete-interfaces +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-add.md b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-add.md new file mode 100644 index 0000000000..ab50d1e597 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-add.md @@ -0,0 +1,95 @@ +# `nico-admin-cli switch health-report add` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [health-report](./switch-health-report.md) › **add**_ + +## NAME + +nico-admin-cli-switch-health-report-add - Insert a health report source +for a switch + +## SYNOPSIS + +**nico-admin-cli switch health-report add** \[**--health-report**\] +\[**--template**\] \[**--message**\] \[**--replace**\] +\[**--print-only**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SWITCH_ID*\> + +## DESCRIPTION + +Insert a health report source for a switch + +## OPTIONS + +**--health-report** *\* +New health report as json + +**--template** *\* +Predefined Template name\ + +\ +*Possible values:* + +- host-update + +- internal-maintenance + +- out-for-repair + +- degraded + +- validation + +- suppress-external-alerting + +- mark-healthy + +- stop-reboot-for-automatic-recovery-from-state-machine + +- tenant-reported-issue + +- request-online-repair + +- request-repair + +**--message** *\* +Message to be filled in template. + +**--replace** +Replace all other health reports with this source + +**--print-only** +Print the template that is going to be send to carbide + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH_ID*\> + +## Examples + +```sh +nico-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 --template internal-maintenance --message "Firmware upgrade in progress" +nico-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 --health-report '{...}' +nico-admin-cli switch health-report add 12345678-1234-5678-90ab-cdef01234567 --template degraded --print-only +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-print-empty-template.md b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-print-empty-template.md new file mode 100644 index 0000000000..8c54bde251 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-print-empty-template.md @@ -0,0 +1,43 @@ +# `nico-admin-cli switch health-report print-empty-template` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [health-report](./switch-health-report.md) › **print-empty-template**_ + +## NAME + +nico-admin-cli-switch-health-report-print-empty-template - Print an +empty health report template + +## SYNOPSIS + +**nico-admin-cli switch health-report print-empty-template** +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print an empty health report template + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-remove.md b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-remove.md new file mode 100644 index 0000000000..10ed4e5a15 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-remove.md @@ -0,0 +1,53 @@ +# `nico-admin-cli switch health-report remove` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [health-report](./switch-health-report.md) › **remove**_ + +## NAME + +nico-admin-cli-switch-health-report-remove - Remove a health report +source from a switch + +## SYNOPSIS + +**nico-admin-cli switch health-report remove** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*SWITCH_ID*\> +\<*REPORT_SOURCE*\> + +## DESCRIPTION + +Remove a health report source from a switch + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH_ID*\> +\<*REPORT_SOURCE*\> + +## Examples + +```sh +nico-admin-cli switch health-report remove 12345678-1234-5678-90ab-cdef01234567 internal-maintenance +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-show.md b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-show.md new file mode 100644 index 0000000000..6b5c36c58b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli switch health-report show` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [health-report](./switch-health-report.md) › **show**_ + +## NAME + +nico-admin-cli-switch-health-report-show - List health report sources +for a switch + +## SYNOPSIS + +**nico-admin-cli switch health-report show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*SWITCH_ID*\> + +## DESCRIPTION + +List health report sources for a switch + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH_ID*\> +Switch ID to show health reports for + +## Examples + +```sh +nico-admin-cli switch health-report show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-health-report.md b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report.md new file mode 100644 index 0000000000..5cf0d292a9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-health-report.md @@ -0,0 +1,51 @@ +# `nico-admin-cli switch health-report` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › **health-report**_ + +## NAME + +nico-admin-cli-switch-health-report - Manage health report sources + +## SYNOPSIS + +**nico-admin-cli switch health-report** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage health report sources + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./switch-health-report-show.md) | List health report sources for a switch | +| [`add`](./switch-health-report-add.md) | Insert a health report source for a switch | +| [`print-empty-template`](./switch-health-report-print-empty-template.md) | Print an empty health report template | +| [`remove`](./switch-health-report-remove.md) | Remove a health report source from a switch | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-list.md b/docs/manuals/nico-admin-cli/commands/switch/switch-list.md new file mode 100644 index 0000000000..a2d955c3cc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-list.md @@ -0,0 +1,73 @@ +# `nico-admin-cli switch list` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › **list**_ + +## NAME + +nico-admin-cli-switch-list - List all switches + +## SYNOPSIS + +**nico-admin-cli switch list** \[**--deleted**\] +\[**--controller-state**\] \[**--bmc-mac**\] \[**--nvos-mac**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +List all switches + +## OPTIONS + +**--deleted** *\* \[default: exclude\] +Include deleted switches\ + +\ +*Possible values:* + +- exclude: Exclude deleted resources (default behavior) + +- only: Return only deleted resources + +- include: Include both deleted and non-deleted resources + +**--controller-state** *\* +Filter by controller state (e.g. "ready", "initializing", "error") + +**--bmc-mac** *\* +Filter by BMC MAC address + +**--nvos-mac** *\* +Filter by NVOS MAC address + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli switch list +nico-admin-cli switch list --deleted include +nico-admin-cli switch list --controller-state ready +nico-admin-cli switch list --bmc-mac 00:11:22:33:44:55 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-add-label.md b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-add-label.md new file mode 100644 index 0000000000..77e4bb5dc4 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-add-label.md @@ -0,0 +1,60 @@ +# `nico-admin-cli switch metadata add-label` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [metadata](./switch-metadata.md) › **add-label**_ + +## NAME + +nico-admin-cli-switch-metadata-add-label - Adds a label to the Metadata +of a Switch + +## SYNOPSIS + +**nico-admin-cli switch metadata add-label** \<**--key**\> +\[**--value**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SWITCH*\> + +## DESCRIPTION + +Adds a label to the Metadata of a Switch + +## OPTIONS + +**--key** *\* +The key to add + +**--value** *\* +The optional value to add + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH*\> +The switch which should get updated metadata + +## Examples + +```sh +nico-admin-cli switch metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key edge +nico-admin-cli switch metadata add-label 12345678-1234-5678-90ab-cdef01234567 --key env --value prod +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-from-expected-switch.md b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-from-expected-switch.md new file mode 100644 index 0000000000..af0459f051 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-from-expected-switch.md @@ -0,0 +1,66 @@ +# `nico-admin-cli switch metadata from-expected-switch` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [metadata](./switch-metadata.md) › **from-expected-switch**_ + +## NAME + +nico-admin-cli-switch-metadata-from-expected-switch - Copy Switch +Metadata from Expected-Switch to Switch + +## SYNOPSIS + +**nico-admin-cli switch metadata from-expected-switch** +\[**--replace-all**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SWITCH*\> + +## DESCRIPTION + +Copy Switch Metadata from Expected-Switch to Switch + +## OPTIONS + +**--replace-all** +Whether to fully replace the Metadata that is currently stored on the +Switch. - If not set, existing Metadata on the Switch will not be +touched by executing the command: - The existing Name will not be +changed if the Name is not equivalent to the Switch ID or Empty. - The +existing Description will not be changed if it is not empty. - Existing +Labels and their values will not be changed. Only labels which do not +exist on the Switch will be added. - If set, the Switches Metadata will +be set to the same values as they would if the Switch would get freshly +ingested. Metadata that is currently set on the Switch will be +overridden. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH*\> +The switch which should get updated metadata + +## Examples + +```sh +nico-admin-cli switch metadata from-expected-switch 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli switch metadata from-expected-switch 12345678-1234-5678-90ab-cdef01234567 --replace-all +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-remove-labels.md b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-remove-labels.md new file mode 100644 index 0000000000..4ab44b1d48 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-remove-labels.md @@ -0,0 +1,55 @@ +# `nico-admin-cli switch metadata remove-labels` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [metadata](./switch-metadata.md) › **remove-labels**_ + +## NAME + +nico-admin-cli-switch-metadata-remove-labels - Removes labels from the +Metadata of a Switch + +## SYNOPSIS + +**nico-admin-cli switch metadata remove-labels** \[**--keys**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \<*SWITCH*\> + +## DESCRIPTION + +Removes labels from the Metadata of a Switch + +## OPTIONS + +**--keys** *\* +The keys to remove + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH*\> +The switch which should get updated metadata + +## Examples + +```sh +nico-admin-cli switch metadata remove-labels 12345678-1234-5678-90ab-cdef01234567 --keys env --keys edge +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-set.md b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-set.md new file mode 100644 index 0000000000..404151a344 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-set.md @@ -0,0 +1,59 @@ +# `nico-admin-cli switch metadata set` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [metadata](./switch-metadata.md) › **set**_ + +## NAME + +nico-admin-cli-switch-metadata-set - Set the Name or Description of the +Switch + +## SYNOPSIS + +**nico-admin-cli switch metadata set** \[**--name**\] +\[**--description**\] \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*SWITCH*\> + +## DESCRIPTION + +Set the Name or Description of the Switch + +## OPTIONS + +**--name** *\* +The updated name of the Switch + +**--description** *\* +The updated description of the Switch + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH*\> +The switch which should get updated metadata + +## Examples + +```sh +nico-admin-cli switch metadata set 12345678-1234-5678-90ab-cdef01234567 --name spine-01 --description "Rack 4 spine" +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-show.md b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-show.md new file mode 100644 index 0000000000..1d5a678a04 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata-show.md @@ -0,0 +1,51 @@ +# `nico-admin-cli switch metadata show` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › [metadata](./switch-metadata.md) › **show**_ + +## NAME + +nico-admin-cli-switch-metadata-show - Show the Metadata of the Switch + +## SYNOPSIS + +**nico-admin-cli switch metadata show** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*SWITCH*\> + +## DESCRIPTION + +Show the Metadata of the Switch + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*SWITCH*\> +The switch which should get its metadata displayed + +## Examples + +```sh +nico-admin-cli switch metadata show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-metadata.md b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata.md new file mode 100644 index 0000000000..af58ad62ef --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-metadata.md @@ -0,0 +1,52 @@ +# `nico-admin-cli switch metadata` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › **metadata**_ + +## NAME + +nico-admin-cli-switch-metadata - Manage Switch Metadata + +## SYNOPSIS + +**nico-admin-cli switch metadata** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage Switch Metadata + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`set`](./switch-metadata-set.md) | Set the Name or Description of the Switch | +| [`show`](./switch-metadata-show.md) | Show the Metadata of the Switch | +| [`add-label`](./switch-metadata-add-label.md) | Adds a label to the Metadata of a Switch | +| [`remove-labels`](./switch-metadata-remove-labels.md) | Removes labels from the Metadata of a Switch | +| [`from-expected-switch`](./switch-metadata-from-expected-switch.md) | Copy Switch Metadata from Expected-Switch to Switch | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch-show.md b/docs/manuals/nico-admin-cli/commands/switch/switch-show.md new file mode 100644 index 0000000000..91f7055985 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli switch show` + +_[Hardware commands](../../hardware.md) › [switch](./switch.md) › **show**_ + +## NAME + +nico-admin-cli-switch-show - Show switch information + +## SYNOPSIS + +**nico-admin-cli switch show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*SWITCH_ID*\] + +## DESCRIPTION + +Show switch information + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*SWITCH_ID*\] +The switch ID to query. Omit to show all switches. + +## Examples + +```sh +nico-admin-cli switch show +nico-admin-cli switch show 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/switch/switch.md b/docs/manuals/nico-admin-cli/commands/switch/switch.md new file mode 100644 index 0000000000..3094cadfbc --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/switch/switch.md @@ -0,0 +1,52 @@ +# `nico-admin-cli switch` + +_[Hardware commands](../../hardware.md) › **switch**_ + +## NAME + +nico-admin-cli-switch - Switch management + +## SYNOPSIS + +**nico-admin-cli switch** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Switch management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./switch-show.md) | Show switch information | +| [`list`](./switch-list.md) | List all switches | +| [`force-delete`](./switch-force-delete.md) | Force delete a switch and optionally its interfaces | +| [`metadata`](./switch-metadata.md) | Manage Switch Metadata | +| [`health-report`](./switch-health-report.md) | Manage health report sources | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tenant-key-set/tenant-key-set-show.md b/docs/manuals/nico-admin-cli/commands/tenant-key-set/tenant-key-set-show.md new file mode 100644 index 0000000000..9d18eaed0d --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tenant-key-set/tenant-key-set-show.md @@ -0,0 +1,57 @@ +# `nico-admin-cli tenant-key-set show` + +_[Tenant commands](../../tenant.md) › [tenant-key-set](./tenant-key-set.md) › **show**_ + +## NAME + +nico-admin-cli-tenant-key-set-show - Display Tenant KeySet information + +## SYNOPSIS + +**nico-admin-cli tenant-key-set show** \[**-t**\|**--tenant-org-id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display Tenant KeySet information + +## OPTIONS + +**-t**, **--tenant-org-id** *\* +The Tenant Org ID to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] \[default: \] +The Tenant KeySet ID in the format of \/\ to +query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli tenant-key-set show +nico-admin-cli tenant-key-set show fds34511233a/87654321-4321-8765-cdef-0123456789ab +nico-admin-cli tenant-key-set show --tenant-org-id fds34511233a +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tenant-key-set/tenant-key-set.md b/docs/manuals/nico-admin-cli/commands/tenant-key-set/tenant-key-set.md new file mode 100644 index 0000000000..e20b2114b5 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tenant-key-set/tenant-key-set.md @@ -0,0 +1,48 @@ +# `nico-admin-cli tenant-key-set` + +_[Tenant commands](../../tenant.md) › **tenant-key-set**_ + +## NAME + +nico-admin-cli-tenant-key-set - Tenant KeySet related handling + +## SYNOPSIS + +**nico-admin-cli tenant-key-set** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Tenant KeySet related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./tenant-key-set-show.md) | Display Tenant KeySet information | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tenant/tenant-show.md b/docs/manuals/nico-admin-cli/commands/tenant/tenant-show.md new file mode 100644 index 0000000000..cda9559620 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tenant/tenant-show.md @@ -0,0 +1,52 @@ +# `nico-admin-cli tenant show` + +_[Tenant commands](../../tenant.md) › [tenant](./tenant.md) › **show**_ + +## NAME + +nico-admin-cli-tenant-show - Display tenant details + +## SYNOPSIS + +**nico-admin-cli tenant show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \[*TENANT_ORG*\] + +## DESCRIPTION + +Display tenant details + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*TENANT_ORG*\] +Optional, tenant org ID to restrict the search + +## Examples + +```sh +nico-admin-cli tenant show +nico-admin-cli tenant show fds34511233a +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tenant/tenant-update.md b/docs/manuals/nico-admin-cli/commands/tenant/tenant-update.md new file mode 100644 index 0000000000..8e904db492 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tenant/tenant-update.md @@ -0,0 +1,65 @@ +# `nico-admin-cli tenant update` + +_[Tenant commands](../../tenant.md) › [tenant](./tenant.md) › **update**_ + +## NAME + +nico-admin-cli-tenant-update - Update an existing tenant + +## SYNOPSIS + +**nico-admin-cli tenant update** \[**-p**\|**--routing-profile-type**\] +\[**-v**\|**--version**\] \[**-n**\|**--name**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*TENANT_ORG*\] + +## DESCRIPTION + +Update an existing tenant + +## OPTIONS + +**-p**, **--routing-profile-type** *\* +Optional, routing profile name to apply to the tenant + +**-v**, **--version** *\* +Optional, version to use for comparison when performing the update, +which will be rejected if the actual version of the record does not +match the value of this parameter + +**-n**, **--name** *\* +Organization name of the tenant + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*TENANT_ORG*\] +Tenant org ID to update + +## Examples + +```sh +nico-admin-cli tenant update fds34511233a --name "Acme Corp" +nico-admin-cli tenant update fds34511233a --routing-profile-type default +nico-admin-cli tenant update fds34511233a --name "Acme Corp" --version 7 +``` + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tenant/tenant.md b/docs/manuals/nico-admin-cli/commands/tenant/tenant.md new file mode 100644 index 0000000000..51f880e5c7 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tenant/tenant.md @@ -0,0 +1,49 @@ +# `nico-admin-cli tenant` + +_[Tenant commands](../../tenant.md) › **tenant**_ + +## NAME + +nico-admin-cli-tenant - Tenant management + +## SYNOPSIS + +**nico-admin-cli tenant** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Tenant management + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./tenant-show.md) | Display tenant details | +| [`update`](./tenant-update.md) | Update an existing tenant | + +--- + +**See also:** [Tenant commands](../../tenant.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-add-bulk.md b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-add-bulk.md new file mode 100644 index 0000000000..76d7a121bd --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-add-bulk.md @@ -0,0 +1,52 @@ +# `nico-admin-cli tpm-ca add-bulk` + +_[Hardware commands](../../hardware.md) › [tpm-ca](./tpm-ca.md) › **add-bulk**_ + +## NAME + +nico-admin-cli-tpm-ca-add-bulk - Add all certificates in a dir as CA +certificates + +## SYNOPSIS + +**nico-admin-cli tpm-ca add-bulk** \<**-d**\|**--dirname**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add all certificates in a dir as CA certificates + +## OPTIONS + +**-d**, **--dirname** *\* +Directory path containing all CA certs + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli tpm-ca add-bulk --dirname /path/to/tpm-ca-certs/ +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-add.md b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-add.md new file mode 100644 index 0000000000..aa68be6059 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-add.md @@ -0,0 +1,52 @@ +# `nico-admin-cli tpm-ca add` + +_[Hardware commands](../../hardware.md) › [tpm-ca](./tpm-ca.md) › **add**_ + +## NAME + +nico-admin-cli-tpm-ca-add - Add TPM CA certificate encoded in +DER/CER/PEM format in a given file + +## SYNOPSIS + +**nico-admin-cli tpm-ca add** \<**-f**\|**--filename**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Add TPM CA certificate encoded in DER/CER/PEM format in a given file + +## OPTIONS + +**-f**, **--filename** *\* +File name containing certificate in DER format + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli tpm-ca add --filename /path/to/tpm-ca.der +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-delete.md b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-delete.md new file mode 100644 index 0000000000..92b6c224a8 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli tpm-ca delete` + +_[Hardware commands](../../hardware.md) › [tpm-ca](./tpm-ca.md) › **delete**_ + +## NAME + +nico-admin-cli-tpm-ca-delete - Delete TPM CA certificate with a given id + +## SYNOPSIS + +**nico-admin-cli tpm-ca delete** \<**-c**\|**--ca-id**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete TPM CA certificate with a given id + +## OPTIONS + +**-c**, **--ca-id** *\* +TPM CA id obtained from the show command + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli tpm-ca delete --ca-id 42 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-show-unmatched-ek.md b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-show-unmatched-ek.md new file mode 100644 index 0000000000..d454b4b915 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-show-unmatched-ek.md @@ -0,0 +1,49 @@ +# `nico-admin-cli tpm-ca show-unmatched-ek` + +_[Hardware commands](../../hardware.md) › [tpm-ca](./tpm-ca.md) › **show-unmatched-ek**_ + +## NAME + +nico-admin-cli-tpm-ca-show-unmatched-ek - Show TPM EK certificates for +which there is no CA match + +## SYNOPSIS + +**nico-admin-cli tpm-ca show-unmatched-ek** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show TPM EK certificates for which there is no CA match + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli tpm-ca show-unmatched-ek +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-show.md b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-show.md new file mode 100644 index 0000000000..147d270c0a --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca-show.md @@ -0,0 +1,42 @@ +# `nico-admin-cli tpm-ca show` + +_[Hardware commands](../../hardware.md) › [tpm-ca](./tpm-ca.md) › **show**_ + +## NAME + +nico-admin-cli-tpm-ca-show - Show all TPM CA certificates + +## SYNOPSIS + +**nico-admin-cli tpm-ca show** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] + +## DESCRIPTION + +Show all TPM CA certificates + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca.md b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca.md new file mode 100644 index 0000000000..0210d28f2f --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/tpm-ca/tpm-ca.md @@ -0,0 +1,52 @@ +# `nico-admin-cli tpm-ca` + +_[Hardware commands](../../hardware.md) › **tpm-ca**_ + +## NAME + +nico-admin-cli-tpm-ca - Manage TPM CA certificates + +## SYNOPSIS + +**nico-admin-cli tpm-ca** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Manage TPM CA certificates + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./tpm-ca-show.md) | Show all TPM CA certificates | +| [`delete`](./tpm-ca-delete.md) | Delete TPM CA certificate with a given id | +| [`add`](./tpm-ca-add.md) | Add TPM CA certificate encoded in DER/CER/PEM format in a given file | +| [`show-unmatched-ek`](./tpm-ca-show-unmatched-ek.md) | Show TPM EK certificates for which there is no CA match | +| [`add-bulk`](./tpm-ca-add-bulk.md) | Add all certificates in a dir as CA certificates | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/trim-table/trim-table-measured-boot.md b/docs/manuals/nico-admin-cli/commands/trim-table/trim-table-measured-boot.md new file mode 100644 index 0000000000..f143787915 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/trim-table/trim-table-measured-boot.md @@ -0,0 +1,50 @@ +# `nico-admin-cli trim-table measured-boot` + +_[Hardware commands](../../hardware.md) › [trim-table](./trim-table.md) › **measured-boot**_ + +## NAME + +nico-admin-cli-trim-table-measured-boot + +## SYNOPSIS + +**nico-admin-cli trim-table measured-boot** \<**--keep-entries**\> +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +## OPTIONS + +**--keep-entries** *\* +Number of entries to keep + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli trim-table measured-boot --keep-entries 1000 +nico-admin-cli trim-table measured-boot --keep-entries 1 +``` + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/trim-table/trim-table.md b/docs/manuals/nico-admin-cli/commands/trim-table/trim-table.md new file mode 100644 index 0000000000..0577605d00 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/trim-table/trim-table.md @@ -0,0 +1,48 @@ +# `nico-admin-cli trim-table` + +_[Hardware commands](../../hardware.md) › **trim-table**_ + +## NAME + +nico-admin-cli-trim-table - Trim DB tables + +## SYNOPSIS + +**nico-admin-cli trim-table** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +Trim DB tables + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`measured-boot`](./trim-table-measured-boot.md) | | + +--- + +**See also:** [Hardware commands](../../hardware.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/version/version.md b/docs/manuals/nico-admin-cli/commands/version/version.md new file mode 100644 index 0000000000..a90909f272 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/version/version.md @@ -0,0 +1,52 @@ +# `nico-admin-cli version` + +_[Admin commands](../../admin.md) › **version**_ + +## NAME + +nico-admin-cli-version - Print API server version + +## SYNOPSIS + +**nico-admin-cli version** \[**-s**\|**--show-runtime-config**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Print API server version + +## OPTIONS + +**-s**, **--show-runtime-config** +Display Runtime Config also. + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli version +nico-admin-cli version --show-runtime-config +``` + +--- + +**See also:** [Admin commands](../../admin.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-create.md b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-create.md new file mode 100644 index 0000000000..206b2d484b --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-create.md @@ -0,0 +1,58 @@ +# `nico-admin-cli vpc-peering create` + +_[Network commands](../../network.md) › [vpc-peering](./vpc-peering.md) › **create**_ + +## NAME + +nico-admin-cli-vpc-peering-create - Create VPC peering. + +## SYNOPSIS + +**nico-admin-cli vpc-peering create** \[**--id**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*VPC1_ID*\> \<*VPC2_ID*\> + +## DESCRIPTION + +Create VPC peering. + +## OPTIONS + +**--id** *\* +Optional desired ID for the VPC peering + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*VPC1_ID*\> +The ID of one VPC ID to peer + +\<*VPC2_ID*\> +The ID of other VPC ID to peer + +## Examples + +```sh +nico-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 +nico-admin-cli vpc-peering create 12345678-1234-5678-90ab-cdef01234567 abcdef01-2345-6789-abcd-ef0123456789 --id 0fedcba9-8765-4321-0fed-cba987654321 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-delete.md b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-delete.md new file mode 100644 index 0000000000..fb7fe557ae --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-delete.md @@ -0,0 +1,51 @@ +# `nico-admin-cli vpc-peering delete` + +_[Network commands](../../network.md) › [vpc-peering](./vpc-peering.md) › **delete**_ + +## NAME + +nico-admin-cli-vpc-peering-delete - Delete VPC peering. + +## SYNOPSIS + +**nico-admin-cli vpc-peering delete** \<**--id**\> \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Delete VPC peering. + +## OPTIONS + +**--id** *\* +The ID of the VPC peering to delete + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli vpc-peering delete --id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-show.md b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-show.md new file mode 100644 index 0000000000..993c1345b6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering-show.md @@ -0,0 +1,56 @@ +# `nico-admin-cli vpc-peering show` + +_[Network commands](../../network.md) › [vpc-peering](./vpc-peering.md) › **show**_ + +## NAME + +nico-admin-cli-vpc-peering-show - Show list of VPC peerings. + +## SYNOPSIS + +**nico-admin-cli vpc-peering show** \[**--id**\] \[**--vpc-id**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] + +## DESCRIPTION + +Show list of VPC peerings. + +## OPTIONS + +**--id** *\* +The ID of the VPC peering to show + +**--vpc-id** *\* +The ID of the VPC to show VPC peerings for + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Examples + +```sh +nico-admin-cli vpc-peering show +nico-admin-cli vpc-peering show --id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli vpc-peering show --vpc-id 12345678-1234-5678-90ab-cdef01234567 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering.md b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering.md new file mode 100644 index 0000000000..f1c7c81d21 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc-peering/vpc-peering.md @@ -0,0 +1,50 @@ +# `nico-admin-cli vpc-peering` + +_[Network commands](../../network.md) › **vpc-peering**_ + +## NAME + +nico-admin-cli-vpc-peering - VPC peering handling + +## SYNOPSIS + +**nico-admin-cli vpc-peering** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +VPC peering handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`create`](./vpc-peering-create.md) | Create VPC peering. | +| [`show`](./vpc-peering-show.md) | Show list of VPC peerings. | +| [`delete`](./vpc-peering-delete.md) | Delete VPC peering. | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc-prefix/vpc-prefix-show.md b/docs/manuals/nico-admin-cli/commands/vpc-prefix/vpc-prefix-show.md new file mode 100644 index 0000000000..732182f3c2 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc-prefix/vpc-prefix-show.md @@ -0,0 +1,76 @@ +# `nico-admin-cli vpc-prefix show` + +_[Network commands](../../network.md) › [vpc-prefix](./vpc-prefix.md) › **show**_ + +## NAME + +nico-admin-cli-vpc-prefix-show + +## SYNOPSIS + +**nico-admin-cli vpc-prefix show** \[**--vpc-id**\] \[**--contains**\] +\[**--contained-by**\] \[**--deleted**\] \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \[*VpcPrefixSelector*\] + +## DESCRIPTION + +## OPTIONS + +**--vpc-id** *\* +Search by VPC ID + +**--contains** *\* +Search by an address or prefix the VPC prefix contains + +**--contained-by** *\* +Search by a prefix containing the VPC prefix + +**--deleted** *\* \[default: exclude\] +Include soft-deleted VPC prefixes\ + +\ +*Possible values:* + +- exclude: Exclude deleted resources (default behavior) + +- only: Return only deleted resources + +- include: Include both deleted and non-deleted resources + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*VpcPrefixSelector*\] +The VPC prefix (by ID or exact unique prefix) to show (omit for all) + +## Examples + +```sh +nico-admin-cli vpc-prefix show +nico-admin-cli vpc-prefix show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli vpc-prefix show 10.0.0.0/24 +nico-admin-cli vpc-prefix show --vpc-id 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli vpc-prefix show --contains 10.0.0.5 +nico-admin-cli vpc-prefix show --contained-by 10.0.0.0/16 +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc-prefix/vpc-prefix.md b/docs/manuals/nico-admin-cli/commands/vpc-prefix/vpc-prefix.md new file mode 100644 index 0000000000..df70ed1018 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc-prefix/vpc-prefix.md @@ -0,0 +1,48 @@ +# `nico-admin-cli vpc-prefix` + +_[Network commands](../../network.md) › **vpc-prefix**_ + +## NAME + +nico-admin-cli-vpc-prefix - VPC prefix handling + +## SYNOPSIS + +**nico-admin-cli vpc-prefix** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +VPC prefix handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./vpc-prefix-show.md) | | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc/vpc-set-virtualizer.md b/docs/manuals/nico-admin-cli/commands/vpc/vpc-set-virtualizer.md new file mode 100644 index 0000000000..1f3be8f8b9 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc/vpc-set-virtualizer.md @@ -0,0 +1,67 @@ +# `nico-admin-cli vpc set-virtualizer` + +_[Network commands](../../network.md) › [vpc](./vpc.md) › **set-virtualizer**_ + +## NAME + +nico-admin-cli-vpc-set-virtualizer + +## SYNOPSIS + +**nico-admin-cli vpc set-virtualizer** \[**--extended**\] +\[**--sort-by**\] \[**-h**\|**--help**\] \<*ID*\> \<*VIRTUALIZER*\> + +## DESCRIPTION + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\<*ID*\> +The VPC ID for the VPC to update + +\<*VIRTUALIZER*\> +The virtualizer to use for this VPC\ + +\ +*Possible values:* + +- ethernet-virtualizer + +- fnn + +- flat: \`Flat\` is for VPCs whose tenant instances live directly on the + underlay (zero-DPU hosts, or hosts with their DPU in NIC mode) and + whose interfaces are bound to \`HostInband\` network segments rather + than a NICo-managed overlay. Flat VPCs are still real tenant VPCs with + a VNI and NSGs, but NICo doesnt drive their data plane -- routing and + ACL enforcement between Flat VPCs and other VPCs is the network + operators responsibility + +## Examples + +```sh +nico-admin-cli vpc set-virtualizer 12345678-1234-5678-90ab-cdef01234567 fnn +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc/vpc-show.md b/docs/manuals/nico-admin-cli/commands/vpc/vpc-show.md new file mode 100644 index 0000000000..a16760eb9e --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc/vpc-show.md @@ -0,0 +1,67 @@ +# `nico-admin-cli vpc show` + +_[Network commands](../../network.md) › [vpc](./vpc.md) › **show**_ + +## NAME + +nico-admin-cli-vpc-show - Display VPC information + +## SYNOPSIS + +**nico-admin-cli vpc show** \[**-t**\|**--tenant-org-id**\] +\[**-n**\|**--name**\] \[**--label-key**\] \[**--label-value**\] +\[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] \[*ID*\] + +## DESCRIPTION + +Display VPC information + +## OPTIONS + +**-t**, **--tenant-org-id** *\* +The Tenant Org ID to query + +**-n**, **--name** *\* +The VPC name to query + +**--label-key** *\* +The key of VPC label to query + +**--label-value** *\* +The value of VPC label to query + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +\[*ID*\] +The VPC ID to query, leave empty for all (default) + +## Examples + +```sh +nico-admin-cli vpc show +nico-admin-cli vpc show 12345678-1234-5678-90ab-cdef01234567 +nico-admin-cli vpc show --tenant-org-id fds34511233a +nico-admin-cli vpc show --label-key env --label-value prod +``` + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/commands/vpc/vpc.md b/docs/manuals/nico-admin-cli/commands/vpc/vpc.md new file mode 100644 index 0000000000..abc9d0daf6 --- /dev/null +++ b/docs/manuals/nico-admin-cli/commands/vpc/vpc.md @@ -0,0 +1,49 @@ +# `nico-admin-cli vpc` + +_[Network commands](../../network.md) › **vpc**_ + +## NAME + +nico-admin-cli-vpc - VPC related handling + +## SYNOPSIS + +**nico-admin-cli vpc** \[**--extended**\] \[**--sort-by**\] +\[**-h**\|**--help**\] \<*subcommands*\> + +## DESCRIPTION + +VPC related handling + +## OPTIONS + +**--extended** +Extended result output. + +This used by measured boot, where basic output contains just what you +probably care about, and "extended" output also dumps out all the +internal UUIDs that are used to associate instances. + +**--sort-by** *\* \[default: primary-id\] +Sort output by specified field\ + +\ +*Possible values:* + +- primary-id: Sort by the primary id + +- state: Sort by state + +**-h**, **--help** +Print help (see a summary with -h) + +## Subcommands + +| Subcommand | Description | +|---|---| +| [`show`](./vpc-show.md) | Display VPC information | +| [`set-virtualizer`](./vpc-set-virtualizer.md) | | + +--- + +**See also:** [Network commands](../../network.md) · [CLI reference index](../../README.md) diff --git a/docs/manuals/nico-admin-cli/hardware.md b/docs/manuals/nico-admin-cli/hardware.md new file mode 100644 index 0000000000..0e4283981d --- /dev/null +++ b/docs/manuals/nico-admin-cli/hardware.md @@ -0,0 +1,39 @@ +# CLI reference — Hardware + +Live hardware and lifecycle operations: machines, BMC, DPUs, firmware and component lifecycle, attestation, low-level passthrough (Redfish, RMS, MLX), and operator utilities. + +For global flags and setup, see [the overview](./README.md) and [`setup.md`](./setup.md). For task-oriented sequences see [`workflows.md`](./workflows.md). + +| Command | Description | +|---|---| +| [`attestation`](./commands/attestation/attestation.md) | MeasuredBoot or SPDM attestations. | +| [`bmc-machine`](./commands/bmc-machine/bmc-machine.md) | BMC Machine related handling. | +| [`boot-override`](./commands/boot-override/boot-override.md) | Machine boot override. | +| [`browse`](./commands/browse/browse.md) | Browse subsystem resource trees via the API server. | +| [`component-manager`](./commands/component-manager/component-manager.md) | Component manager actions. | +| [`credential`](./commands/credential/credential.md) | Credential related handling. | +| [`dpa`](./commands/dpa/dpa.md) | DPA related handling. | +| [`dpf`](./commands/dpf/dpf.md) | DPF-related commands. | +| [`dpu`](./commands/dpu/dpu.md) | DPU specific handling. | +| [`dpu-remediation`](./commands/dpu-remediation/dpu-remediation.md) | Dpu Remediation handling. | +| [`firmware`](./commands/firmware/firmware.md) | Firmware related actions. | +| [`host`](./commands/host/host.md) | Host specific handling. | +| [`inventory`](./commands/inventory/inventory.md) | Generate Ansible Inventory. | +| [`machine`](./commands/machine/machine.md) | Machine related handling. | +| [`machine-interfaces`](./commands/machine-interfaces/machine-interfaces.md) | Machine interfaces and address management. | +| [`machine-validation`](./commands/machine-validation/machine-validation.md) | Machine Validation. | +| [`managed-host`](./commands/managed-host/managed-host.md) | Managed host related handling. | +| [`managed-switch`](./commands/managed-switch/managed-switch.md) | Managed switch related handling. | +| [`mlx`](./commands/mlx/mlx.md) | Mellanox Device Handling. | +| [`nvl-partition`](./commands/nvl-partition/nvl-partition.md) | NvLink Partition related handling. | +| [`nvlink-nmxc-endpoints`](./commands/nvlink-nmxc-endpoints/nvlink-nmxc-endpoints.md) | Rack chassis serial → NMX-C endpoint mappings. | +| [`power-shelf`](./commands/power-shelf/power-shelf.md) | Power Shelf management. | +| [`rack`](./commands/rack/rack.md) | Rack Management. | +| [`redfish`](./commands/redfish/redfish.md) | Redfish BMC actions. | +| [`rms`](./commands/rms/rms.md) | RMS Actions. | +| [`scout-stream`](./commands/scout-stream/scout-stream.md) | Scout Stream Connection Handling. | +| [`set`](./commands/set/set.md) | Set carbide-api dynamic features. | +| [`sku`](./commands/sku/sku.md) | Manage machine SKUs. | +| [`switch`](./commands/switch/switch.md) | Switch management. | +| [`tpm-ca`](./commands/tpm-ca/tpm-ca.md) | Manage TPM CA certificates. | +| [`trim-table`](./commands/trim-table/trim-table.md) | Trim DB tables. | diff --git a/docs/manuals/nico-admin-cli/index.md b/docs/manuals/nico-admin-cli/index.md new file mode 100644 index 0000000000..c8f0e7d140 --- /dev/null +++ b/docs/manuals/nico-admin-cli/index.md @@ -0,0 +1,18 @@ +# `nico-admin-cli` reference + +`nico-admin-cli` is the command-line tool for managing a NICo site. It +communicates with `nico-api` over gRPC with mutual TLS (mTLS). + +For building the CLI, connecting to `nico-api`, TLS flag reference, logging, +and a quick connectivity check, see [`nico-admin-cli.md`](../nico-admin-cli.md). +For mTLS cert generation and server-side auth configuration, see +[`nico-api-auth.md`](../nico-api-auth.md). + +## Command reference + +| Domain | Commands | +|--------|----------| +| [Hardware](./hardware.md) | Machines, BMC, DPUs, firmware, attestation, Redfish, RMS, MLX | +| [Network](./network.md) | VPCs, peerings, prefixes, segments, security groups, IB/NVLink, IP/domain lookups | +| [Tenant](./tenant.md) | Tenants, instances, compute allocations, expected-inventory, OS images, iPXE, extension services | +| [Admin](./admin.md) | CLI and system utilities | diff --git a/docs/manuals/nico-admin-cli/network.md b/docs/manuals/nico-admin-cli/network.md new file mode 100644 index 0000000000..d8ff410e87 --- /dev/null +++ b/docs/manuals/nico-admin-cli/network.md @@ -0,0 +1,22 @@ +# CLI reference — Network + +VPCs, peerings, prefixes, network segments and devices, security groups, IB/NVLink fabric partitions, IP/domain lookups, and resource pools. + +For global flags and setup, see [the overview](./README.md) and [`setup.md`](./setup.md). For task-oriented sequences see [`workflows.md`](./workflows.md). + +| Command | Description | +|---|---| +| [`domain`](./commands/domain/domain.md) | Domain related handling. | +| [`ib-partition`](./commands/ib-partition/ib-partition.md) | InfiniBand Partition related handling. | +| [`ip`](./commands/ip/ip.md) | IP address handling. | +| [`logical-partition`](./commands/logical-partition/logical-partition.md) | Logical partition related handling. | +| [`network-device`](./commands/network-device/network-device.md) | Network Devices handling. | +| [`network-security-group`](./commands/network-security-group/network-security-group.md) | Network security group management. | +| [`network-segment`](./commands/network-segment/network-segment.md) | Network Segment related handling. | +| [`nvl-domain`](./commands/nvl-domain/nvl-domain.md) | NVLink domain related handling. | +| [`resource-pool`](./commands/resource-pool/resource-pool.md) | Resource pool handling. | +| [`route-server`](./commands/route-server/route-server.md) | Route server handling. | +| [`spx-partition`](./commands/spx-partition/spx-partition.md) | SPX Partition related handling. | +| [`vpc`](./commands/vpc/vpc.md) | VPC related handling. | +| [`vpc-peering`](./commands/vpc-peering/vpc-peering.md) | VPC peering handling. | +| [`vpc-prefix`](./commands/vpc-prefix/vpc-prefix.md) | VPC prefix handling. | diff --git a/docs/manuals/nico-admin-cli/tenant.md b/docs/manuals/nico-admin-cli/tenant.md new file mode 100644 index 0000000000..30d6228a18 --- /dev/null +++ b/docs/manuals/nico-admin-cli/tenant.md @@ -0,0 +1,22 @@ +# CLI reference — Tenant + +Tenants and tenant keysets, instances and instance types, compute allocations, the declarative `expected-*` inventory, operating systems and OS images, iPXE templates, extension services, and the site explorer. + +For global flags and setup, see [the overview](./README.md) and [`setup.md`](./setup.md). For task-oriented sequences see [`workflows.md`](./workflows.md). + +| Command | Description | +|---|---| +| [`compute-allocation`](./commands/compute-allocation/compute-allocation.md) | Compute allocation management. | +| [`expected-machine`](./commands/expected-machine/expected-machine.md) | Expected machine handling. | +| [`expected-power-shelf`](./commands/expected-power-shelf/expected-power-shelf.md) | Expected power shelf handling. | +| [`expected-rack`](./commands/expected-rack/expected-rack.md) | Expected rack handling. | +| [`expected-switch`](./commands/expected-switch/expected-switch.md) | Expected switch handling. | +| [`extension-service`](./commands/extension-service/extension-service.md) | Extension service management. | +| [`instance`](./commands/instance/instance.md) | Instance related handling. | +| [`instance-type`](./commands/instance-type/instance-type.md) | Instance type management. | +| [`ipxe-template`](./commands/ipxe-template/ipxe-template.md) | iPXE template management. | +| [`operating-system`](./commands/operating-system/operating-system.md) | Operating system definition management. | +| [`os-image`](./commands/os-image/os-image.md) | OS catalog management. | +| [`site-explorer`](./commands/site-explorer/site-explorer.md) | Site explorer functions. | +| [`tenant`](./commands/tenant/tenant.md) | Tenant management. | +| [`tenant-key-set`](./commands/tenant-key-set/tenant-key-set.md) | Tenant KeySet related handling. | diff --git a/docs/manuals/nico-api-auth.md b/docs/manuals/nico-api-auth.md new file mode 100644 index 0000000000..7c0410d678 --- /dev/null +++ b/docs/manuals/nico-api-auth.md @@ -0,0 +1,284 @@ +# NICo mTLS and authorization + +`nico-api` uses mutual TLS (mTLS) for all connections: the server presents a +certificate the client verifies against a root CA, and the client presents a +certificate the server verifies against a separate admin CA. Authorization is +then handled by a Casbin RBAC policy that maps certificate fields to roles and +gRPC method permissions. + +## Generating client certificates + +### Creating an admin CA and client cert with OpenSSL + +The following creates a self-contained CA and client certificate. In +production you would typically use your organization's existing PKI +instead of a self-signed CA. + +```sh +# 1. Generate the CA key and self-signed certificate +openssl ecparam -name prime256v1 -genkey -noout -out admin-ca.key +openssl req -x509 -new -key admin-ca.key -sha256 -days 3650 \ + -out admin-ca.crt \ + -subj "/O=ExampleCo/CN=ExampleCo NICo Admin CA" + +# 2. Generate a client key +openssl ecparam -name prime256v1 -genkey -noout -out client.key + +# 3. Create a CSR with operator identity in the subject +# - O = organization (matched by required_equals if configured) +# - OU = group (used for role-based authorization via group_from) +# - CN = username (used for audit logging via username_from) +openssl req -new -key client.key -out client.csr \ + -subj "/O=ExampleCo/OU=site-admins/CN=jdoe" + +# 4. Create an extensions file for clientAuth +cat > client_ext.cnf <` | `external-role/site-admins` | +| Any trusted cert | `trusted-certificate` | | +| No cert | `anonymous` | | + +The `` in `external-role/` comes from the certificate +field specified by `group_from` in `[auth.cli_certs]`. + +##### Writing policy rules + +Sample policy file: + +```csv +# On `g` rules: These associate a principal (second column) with a role name +# (third column). This causes the named role to also be looked up as if it were +# a principal. +# +# On `p` rules: These allow a principal or role (second column) to perform the +# named action (third column). Glob matching is available on the action field. +# + + +# Map the nico-dhcp SPIFFE ID to the nico-dhcp role. +# FIXME: verify that this is how these SPIFFE service identifiers look in reality. +g, spiffe-service-id/nico-dhcp, nico-dhcp +g, spiffe-service-id/nico-dns, nico-dns +g, spiffe-machine-id, machine + +# Allow the nico-dhcp role to call its methods. +p, nico-dhcp, nico/DiscoverDhcp + +# Same idea for nico-dns. +p, nico-dns, nico/LookupRecord + +# Anonymous access to endpoints that don't modify state or expose any customer +# or site data should be fine. +p, anonymous, nico/Version + +# Allow anonymous access to methods used by machines that may not have their +# certificates from us yet. +p, anonymous, nico/DiscoverMachine +p, anonymous, nico/ReportNicoScoutError +p, anonymous, nico/AttestQuote + +# Allow anonymous access to methods used by dpu-agent. As of 2023-09-28 there +# are probably a fair amount of agents across the environments that don't have a +# certificate and are not ready for strict enforcement. +p, anonymous, nico/FindInstanceByMachineID +p, anonymous, nico/GetManagedHostNetworkConfig +p, anonymous, nico/RecordDpuNetworkStatus + +# The client cert generated above has OU=site-admins in its subject. +# With group_from = "SubjectOU" in [auth.cli_certs], that becomes the +# principal "external-role/site-admins". Map it to a role and grant access. +g, external-role/site-admins, site-admin +p, site-admin, nico/* + +# Example of a restricted role: a cert with OU=viewers would only get +# read access to a handful of methods. +g, external-role/viewers, viewer +p, viewer, nico/Version +p, viewer, nico/GetMachine +p, viewer, nico/ListMachines +p, viewer, nico/GetInstance +p, viewer, nico/ListInstances + + +# Allow any certificate we trust to hit any NICo method. +# FIXME: This should be removed once we have more fine-grained rule coverage. +p, trusted-certificate, nico/* +``` + +The method names in the `nico/` column correspond to the gRPC +method names defined in the protobuf service definitions. Glob matching +(`*`) is supported. + +##### Full example: nico-api config with external admin certs + +```toml +[tls] +identity_pemfile_path = "/path/to/server.crt" +identity_keyfile_path = "/path/to/server.key" +root_cafile_path = "/path/to/internal-ca.crt" +admin_root_cafile_path = "/path/to/admin-ca.crt" + +[auth] +permissive_mode = false +casbin_policy_file = "/path/to/casbin-policy.csv" + +[auth.cli_certs] +required_equals = { "IssuerO" = "ExampleCo", "IssuerCN" = "ExampleCo NICo Admin CA" } +group_from = "SubjectOU" +username_from = "SubjectCN" + +[auth.trust] +spiffe_trust_domain = "nico.local" +spiffe_service_base_paths = [ + "/nico-system/sa/", + "/default/sa/", + "/elektra-site-agent/sa/", +] +spiffe_machine_base_path = "/nico-system/machine/" +additional_issuer_cns = [] +``` + +With this configuration, a client certificate with subject +`/O=ExampleCo/OU=site-admins/CN=jdoe` and issuer +`/O=ExampleCo/CN=ExampleCo NICo Admin CA` would: + +1. Pass the `required_equals` check (IssuerO and IssuerCN match) +2. Be assigned group `site-admins` (from SubjectOU) +3. Be identified as user `jdoe` (from SubjectCN) +4. Receive the principal `external-role/site-admins` +5. Be authorized according to whatever casbin policy rules match that + principal + +You can see an example of a complete nico-api configuration file +[here](https://github.com/NVIDIA/ncx-infra-controller-core/blob/main/crates/api/src/cfg/test_data/full_config.toml) + +### Permissive mode + +Setting `permissive_mode = true` in the `[auth]` section causes the +authorization engine to **allow all requests**, even when the casbin +policy would deny them. Denied requests are logged with a warning +instead of being rejected: + +```toml +[auth] +permissive_mode = true +``` + +When permissive mode is active, nico-api logs messages like: + +``` +WARN The policy engine denied this request, but --auth-permissive-mode overrides it. +``` + +**Use permissive mode only for:** + +- Initial deployment and bring-up, before certificates are fully + configured +- Debugging authorization issues (enable temporarily, check logs, then + disable) +- Development environments + +**Do not leave permissive mode enabled in production.** It bypasses all +authorization checks. Any client that can complete the TLS handshake +(or any client at all, if TLS is also disabled) can call any API method. + +You can also set permissive mode via environment variable without +editing the config file: + +```sh +NICO_API_AUTH="{permissive_mode=true}" +```