chef-node-management-cli reference

chef-node-management-cli

Chef Node Management CLI

Options

-h

--help

help for chef-node-management-cli

Default value: false

chef-node-management-cli completion

Generate the autocompletion script for the specified shell

Synopsis

Generate the autocompletion script for chef-node-management-cli for the specified shell. See each sub-command’s help for details on how to use the generated script.

Options

-h

--help

help for completion

Default value: false

chef-node-management-cli completion bash

Generate the autocompletion script for bash

Synopsis

Generate the autocompletion script for the bash shell.

This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.

To load completions in your current shell session:

source <(chef-node-management-cli completion bash)

To load completions for every new session, execute once:

Linux:

chef-node-management-cli completion bash > /etc/bash_completion.d/chef-node-management-cli

macOS:

chef-node-management-cli completion bash > $(brew --prefix)/etc/bash_completion.d/chef-node-management-cli

You will need to start a new shell for this setup to take effect.

completion-bash package

You must have the bash-completion package installed on your workstation to run the completion bash subcommand. To install and configure the package, see the Chef 360 Platform CLI documentation.

Usage

chef-node-management-cli completion bash

Options

-h

--help

help for bash

Default value: false

--no-descriptions

disable completion descriptions

Default value: false

chef-node-management-cli completion fish

Generate the autocompletion script for fish

Synopsis

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

chef-node-management-cli completion fish | source

To load completions for every new session, execute once:

chef-node-management-cli completion fish > ~/.config/fish/completions/chef-node-management-cli.fish

You will need to start a new shell for this setup to take effect.

Usage

chef-node-management-cli completion fish [flags]

Options

-h

--help

help for fish

Default value: false

--no-descriptions

disable completion descriptions

Default value: false

chef-node-management-cli completion powershell

Generate the autocompletion script for powershell

Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

chef-node-management-cli completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

Usage

chef-node-management-cli completion powershell [flags]

Options

-h

--help

help for powershell

Default value: false

--no-descriptions

disable completion descriptions

Default value: false

chef-node-management-cli completion zsh

Generate the autocompletion script for zsh

Synopsis

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(chef-node-management-cli completion zsh)

To load completions for every new session, execute once:

Linux:

chef-node-management-cli completion zsh > "${fpath[1]}/_chef-node-management-cli"

macOS:

chef-node-management-cli completion zsh > $(brew --prefix)/share/zsh/site-functions/_chef-node-management-cli

You will need to start a new shell for this setup to take effect.

Usage

chef-node-management-cli completion zsh [flags]

Options

-h

--help

help for zsh

Default value: false

--no-descriptions

disable completion descriptions

Default value: false

chef-node-management-cli deregister-device

De-register a device

Synopsis

Use this operation to de-register a device

Usage

chef-node-management-cli deregister-device [flags]

Options

--force

force remove profile from local list of profiles, even on error from server

Default value: false

-f

--format

to print response in format

Default value: json

-h

--help

help for deregister-device

Default value: false

--profile

name for the profile of the new api-token

Default value: default

-v

--verbose

to show debug logs

Default value: false

chef-node-management-cli enrollment

Commands related to enrollment

Options

-h

--help

help for enrollment

Default value: false

chef-node-management-cli enrollment bulk-enroll

Bulk enrollment of nodes with the node management

Synopsis

This operation bulk enrolls the nodes in the node management.

Usage

chef-node-management-cli enrollment bulk-enroll [flags]

Options

--file

Takes path of file.

--format

to print response in format

Default value: json

-h

--help

help for bulk-enroll

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli enrollment enroll-node

Enrol a node with the node management

Synopsis

This operation enrol a node in the node management.

Usage

chef-node-management-cli enrollment enroll-node [flags]

Options

--body

The node enrollment request

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for enroll-node

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli get-default-profile

Get default profile for request

Usage

chef-node-management-cli get-default-profile [flags]

Options

-h

--help

help for get-default-profile

Default value: false

chef-node-management-cli list-profile-names

Get the list of profile names available

Usage

chef-node-management-cli list-profile-names [flags]

Options

-h

--help

help for list-profile-names

Default value: false

chef-node-management-cli management

Commands related to state service

Options

-h

--help

help for management

Default value: false

chef-node-management-cli management assembly

Commands related to assembly

Options

-h

--help

help for assembly

Default value: false

chef-node-management-cli management assembly create-assembly

Add a skill assembly.

Synopsis

This operation enables the addition of a new skill assembly to the node management.

Usage

chef-node-management-cli management assembly create-assembly [flags]

Options

--body

The skill assembly to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-assembly

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management assembly delete-assembly

Deletes a skill assembly.

Synopsis

Use this operation to delete a skill assembly using its ID. Deletion of the skill assembly is not allowed when there are any cohorts associated with the given assembly ID.

Usage

chef-node-management-cli management assembly delete-assembly [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for delete-assembly

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillAssemblyId

Id of the skill assembly

--verbose

to show debug logs

Default value: false

chef-node-management-cli management assembly find-all-assemblies

List the skill assemblies under node management.

Synopsis

This operation allows users to search for skill assemblies under node management in the current organization.

Usage

chef-node-management-cli management assembly find-all-assemblies [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-assemblies

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management assembly find-one-assembly

Get a skill assembly by its id.

Synopsis

Use this operation to obtain a skill assembly given its id.

Usage

chef-node-management-cli management assembly find-one-assembly [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-one-assembly

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillAssemblyId

Id of the skill assembly

--verbose

to show debug logs

Default value: false

chef-node-management-cli management assembly update-assembly

Updates a skill assembly rules.

Synopsis

Use this operation to update skill assembly rules. This will replace the entire rule set with the new one.

Usage

chef-node-management-cli management assembly update-assembly [flags]

Options

--body

The skill assembly to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-assembly

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillAssemblyId

Id of the skill assembly

--verbose

to show debug logs

Default value: false

chef-node-management-cli management cohort

Commands related to cohort

Options

-h

--help

help for cohort

Default value: false

chef-node-management-cli management cohort assign-setting

Update a node cohort’s override settings group.

Synopsis

Use this operation to update a node cohort’s associated override settings group.

Usage

chef-node-management-cli management cohort assign-setting [flags]

Options

--cohortId

Id of the node cohort

--format

to print response in format

Default value: json

-h

--help

help for assign-setting

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--settingId

Id of the settings group

--verbose

to show debug logs

Default value: false

chef-node-management-cli management cohort assign-skillAssembly

Update a node cohort’s skill assembly.

Synopsis

Use this operation to update a node cohort’s skill assembly.

Usage

chef-node-management-cli management cohort assign-skillAssembly [flags]

Options

--cohortId

Id of the node cohort

--format

to print response in format

Default value: json

-h

--help

help for assign-skillAssembly

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillAssemblyId

Id of the skill assembly

--verbose

to show debug logs

Default value: false

chef-node-management-cli management cohort create-cohort

Add a node cohort.

Synopsis

This operation enables the addition of a new node cohort to the node management.

Usage

chef-node-management-cli management cohort create-cohort [flags]

Options

--body

The node cohort to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-cohort

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management cohort delete-cohort

Deletes a node cohort.

Synopsis

Use this operation to delete a node cohort using its id. The deletion of the node cohort is not allowed when there are any nodes associated with a given cohort.

Usage

chef-node-management-cli management cohort delete-cohort [flags]

Options

--cohortId

Id of the node cohort

--format

to print response in format

Default value: json

-h

--help

help for delete-cohort

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management cohort find-all-cohorts

List the node cohorts under node management.

Synopsis

This operation allows users to search for node cohorts under node management in the current organization.

Usage

chef-node-management-cli management cohort find-all-cohorts [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-cohorts

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management cohort find-one-cohort

Get a node cohort by its id.

Synopsis

Use this operation to obtain a node cohort given its id.

Usage

chef-node-management-cli management cohort find-one-cohort [flags]

Options

--cohortId

Id of the node cohort

--format

to print response in format

Default value: json

-h

--help

help for find-one-cohort

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter

Commands related to filter

-h

--help

help for filter

Default value: false

chef-node-management-cli management filter create-filter

Add a node filter.

Synopsis

This operation enables the addition of a new node filter to node management. A node filter comprises a set of constraints used to identify matching nodes.

Usage

chef-node-management-cli management filter create-filter [flags]

--body

The node filter to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-filter

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter delete-filter

Delete a node filter by its id.

Synopsis

Use this operation to delete a node filter using its id.

Usage

chef-node-management-cli management filter delete-filter [flags]

--filterId

Id of the node filter

--format

to print response in format

Default value: json

-h

--help

help for delete-filter

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter find-all-filters

List the node filters under node management.

Synopsis

This operation allows users to search for node filters under node management in the current organization.

Usage

chef-node-management-cli management filter find-all-filters [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-filters

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter find-one-filter

Get a node filter by its id.

Synopsis

Use this operation to obtain a node filter given its id.

Usage

chef-node-management-cli management filter find-one-filter [flags]

--filterId

Id of the node filter

--format

to print response in format

Default value: json

-h

--help

help for find-one-filter

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter run-adhocFilter

Runs an adhooc filter and returns the matching nodes.

Synopsis

Use this operation to execute an adhooc filter. The result of each invocation of this operation could yield a different set of nodes.

Usage

chef-node-management-cli management filter run-adhocFilter [flags]

Options

--body

The filter to run

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--expand

Specifies whether to retrieve partial or full node details. Defaults to true to retrieve full node details. Partial retrieval will not include attributes, installed skills, and required skills details.

Default value: true

--format

to print response in format

Default value: json

-h

--help

help for run-adhocFilter

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter run-savedFilter

Runs a saved filter and returns the matching nodes.

Synopsis

Use this operation to execute a saved filter. The result of each invocation of this operation could yield a different set of nodes.

Usage

chef-node-management-cli management filter run-savedFilter [flags]

Options

--expand

Default value: true

--filterId

Id of the node filter

--format

to print response in format

Default value: json

-h

--help

help for run-savedFilter

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management filter update-filter

Update a node filter given its id.

Synopsis

Use this operation to update a node filter. This will replace the existing filter with the new one.

Usage

chef-node-management-cli management filter update-filter [flags]

--body

The updated filter

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--filterId

Id of the node filter

--format

to print response in format

Default value: json

-h

--help

help for update-filter

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list

Commands related to list

Options

-h

--help

help for list

Default value: false

chef-node-management-cli management list add-nodes

Add a list of node IDs to an existing node list.

Synopsis

Use this operation to add new node ids to a node list.

Usage

chef-node-management-cli management list add-nodes [flags]

Options

--body

The node ids to add

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for add-nodes

Default value: false

--listId

Id of the node list

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list create-list

Add a node list.

Synopsis

This operation enables the addition of a new node list to the node management. A node list consists of node IDs managed under node management.

Usage

chef-node-management-cli management list create-list [flags]

Options

--body

The node list to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-list

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list delete-list

Deletes a node list.

Synopsis

Use this operation to delete a node list using its id.

Usage

chef-node-management-cli management list delete-list [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for delete-list

Default value: false

--listId

Id of the node list

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list find-all-lists

List the node lists under node management.

Synopsis

This operation allows users to search for node lists under node management in the current organization.

Usage

chef-node-management-cli management list find-all-lists [flags]

Options

--expand

Indicates whether to retrieve complete or partial details of the node list. By default, this is set to true to retrieve the full details. When set to false, only partial information is returned, which includes only the node list ID and name, excluding other details.

Default value: true

--format

to print response in format

Default value: json

-h

--help

help for find-all-lists

Default value: false

--keyword

The search keyword to filter node lists.

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list find-one-list

Get a node list by its id.

Synopsis

Use this operation to obtain a node list given its id.

Usage

chef-node-management-cli management list find-one-list [flags]

Options

--expand

Specifies whether to retrieve the list with node IDs or node details.

Default value: false

--format

to print response in format

Default value: json

-h

--help

help for find-one-list

Default value: false

--listId

Id of the node list

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list modify-nodes

Update the node list by adding or removing a set of node IDs. The list of node IDs provided in the request will replace the existing node list, making it the final set of nodes associated with the specified list ID.

Synopsis

Use this operation to simultaneously add and remove node IDs, ensuring the node list is updated with the specified set of nodes.

Usage

chef-node-management-cli management list modify-nodes [flags]

Options

--body

The provided node IDs will be used to define the final set of nodes associated with the specified list ID.

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for modify-nodes

Default value: false

--listId

Id of the node list

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management list remove-nodes

Remove a list of node ids to an existing node list.

Synopsis

Use this operation to remove new node ids to a node list.

Usage

chef-node-management-cli management list remove-nodes [flags]

Options

--body

The node ids to remove

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for remove-nodes

Default value: false

--listId

Id of the node list

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node

Commands related to node

Options

-h

--help

help for node

Default value: false

chef-node-management-cli management node assign-cohort

Update a node’s cohort.

Synopsis

Use this operation to update a node’s cohort.

Usage

chef-node-management-cli management node assign-cohort [flags]

Options

--cohortId

Id of the node cohort

--format

to print response in format

Default value: json

-h

--help

help for assign-cohort

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node checkin-node

The subsequent check-in by the node management agent.

Synopsis

This operation is intended to be used by the node management agent, which utilizes it during subsequent check-ins."

Usage

chef-node-management-cli management node checkin-node [flags]

Options

--body

The node's checkin data

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for checkin-node

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node create-node

Synopsis

This operation registers a new node in the node management.

Usage

chef-node-management-cli management node create-node [flags]

Options

--body

The node to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-node

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node delete-attributes

Deletes the attributes with the provided namespace on a node.

Synopsis

Use this operation to delete attributes within a namespace. Attribute names can be provided through query parameters. If names are provided, only those attributes will be deleted. Otherwise, the entire namespace will be deleted.

Usage

chef-node-management-cli management node delete-attributes [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for delete-attributes

Default value: false

--name

The name of the property (attribute or tag)

Default value: []

--namespace

An attribute's namespace

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node delete-tags

Delete the tags on a node.

Synopsis

Use this operation to delete the tags. Tag names can be provided through query parameters. If names are provided, only those tags will be deleted. Otherwise, the entire tags will be deleted.

Usage

chef-node-management-cli management node delete-tags [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for delete-tags

Default value: false

--name

The name of the property (attribute or tag)

Default value: []

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node find-all-nodes

List the nodes under node management.

Synopsis

This operation will allow users to search for nodes under node management in the current organization.

Usage

chef-node-management-cli management node find-all-nodes [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-nodes

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node find-one-node

Get a node uisng its id.

Synopsis

Use this operation to retrieve data for a single node in the node management.

Usage

chef-node-management-cli management node find-one-node [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-one-node

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node find-ou-nodes

Filters a list of node ids to only those nodes in the OU of the request.

Synopsis

Use this operation to provide a list of node ids from potentially mixed OUs and receive a response of lists filtered to the OU of the request.

Usage

chef-node-management-cli management node find-ou-nodes [flags]

Options

--body

The list of node ids to filter

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for find-ou-nodes

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node modify-attributes

Modifies the attributes with the provided namespace on a node.

Synopsis

Use this operation to modify a node’s namespaced attributes. This operation replaces the existing attribute value with the new one and adds any missing attributes.

Usage

chef-node-management-cli management node modify-attributes [flags]

Options

--body

The modified attributes

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for modify-attributes

Default value: false

--namespace

An attribute's namespace

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node modify-tags

Modify the tags on a node.

Synopsis

Use this operation to modify a node’s tags. This operation replaces the existing tag value with the new one and adds any missing tags.

Usage

chef-node-management-cli management node modify-tags [flags]

Options

--body

The modified tags

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for modify-tags

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node update-attributes

Updates the attributes with the provided namespace on a node.

Synopsis

Use this operation to update a node’s namespaced attributes. If any attributes exist for the given namespace, this operation completely replaces the old attributes with the new ones.

Usage

chef-node-management-cli management node update-attributes [flags]

Options

--body

The updated attributes

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-attributes

Default value: false

--namespace

An attribute's namespace

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management node update-tags

Update the tags on a node.

Synopsis

Use this operation to update a node’s tags. If any tags exist, this operation completely replaces the old tags with the new ones.

Usage

chef-node-management-cli management node update-tags [flags]

Options

--body

The updated tags

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-tags

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting

Commands related to setting

Options

-h

--help

help for setting

Default value: false

chef-node-management-cli management setting create-setting

Add a node override settings

Synopsis

This operation will enable the addition of a node override settings based on skill groups.

Usage

chef-node-management-cli management setting create-setting [flags]

Options

--body

The override settings to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-setting

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting delete-setting

Deletes a override settings group

Synopsis

Use this operation to delete a override settings group using its id.

Usage

chef-node-management-cli management setting delete-setting [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for delete-setting

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--settingId

Id of the settings group

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting find-all-default-settings

Get the list of default settings for all the available skills.

Synopsis

Use this operation to obtain all the default settings for all the skills.

Usage

chef-node-management-cli management setting find-all-default-settings [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-default-settings

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting find-all-settings

Get the list of override settings under node management.

Synopsis

Use this operation to obtain all the override settings for a settings group.

Usage

chef-node-management-cli management setting find-all-settings [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-settings

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting find-one-setting

Get override settings by id

Synopsis

Use this operation to obtain override settings for a settings group given its id.

Usage

chef-node-management-cli management setting find-one-setting [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-one-setting

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--settingId

Id of the settings group

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting get-skill-defaultSettings

Get default settings for a skill

Synopsis

Use this operation to obtain default settings for a skill.

Usage

chef-node-management-cli management setting get-skill-defaultSettings [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for get-skill-defaultSettings

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting get-skillSettings

Get merged global and override settings by id and skill

Synopsis

Use this operation to get merged global and override settings for a skill.

Usage

chef-node-management-cli management setting get-skillSettings [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for get-skillSettings

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--settingId

Id of the settings group

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting update-defaultSettings

Update default settings for a skill

Synopsis

Use this operation to update default settings for a skill.

Usage

chef-node-management-cli management setting update-defaultSettings [flags]

Options

--body

The updated skill override settings

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-defaultSettings

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management setting update-skillSettings

Create or update Override Settings for a Skill

Synopsis

Use this operation to update override settings for a skill.

Usage

chef-node-management-cli management setting update-skillSettings [flags]

Options

--body

The updated skill override settings

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-skillSettings

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--settingId

Id of the settings group

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management skill

Commands related to skill

Options

-h

--help

help for skill

Default value: false

chef-node-management-cli management skill create-skill

Add a skill definition

Synopsis

This method will allow the addition of a new skill definition to the node management.

Usage

chef-node-management-cli management skill create-skill [flags]

Options

--body

The skill definition to be added

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for create-skill

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management skill delete-skill

Deletes a skill definition

Synopsis

Use this operation to delete a skill definition using its name.

Usage

chef-node-management-cli management skill delete-skill [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for delete-skill

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management skill find-all-skills

List the skill definitions under node management

Synopsis

This method will list all skill definitions related to management in the current organization.

Usage

chef-node-management-cli management skill find-all-skills [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-all-skills

Default value: false

--pagination.page

what page of the pagination

Default value: 1

--pagination.size

items per page

Default value: 10

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli management skill find-one-skill

Get skill definition

Synopsis

Use this operation to obtain a skill definition using the skill name (it is case-insensitive).

Usage

chef-node-management-cli management skill find-one-skill [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for find-one-skill

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management skill modify-skill

Modify a skill definition

Synopsis

Use this operation to modify a skill definition using its name. Put requests can modify canister, native definitions, as well as configuration templates.

Usage

chef-node-management-cli management skill modify-skill [flags]

Options

--body

The updated skill definition

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for modify-skill

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--skillName

name of Skill

--verbose

to show debug logs

Default value: false

chef-node-management-cli management skill update-agent

Synopsis

The node management agent is a specialized skill; use this operation to update the node management agent’s skill. This operation registers the node management agent as a special skill, enabling the updating of the node management agent. It also establishes the default settings for the node management agent to function during skill installation, as well as for self-updating.

Usage

chef-node-management-cli management skill update-agent [flags]

Options

--body

The data for node management agent skill

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-agent

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli register-device

Usage

chef-node-management-cli register-device [flags]

Options

--cafile

path to ca file

--device-name

name of the device

Default value: device

-f

--format

to print response in format

Default value: json

-h

--help

help for register-device

Default value: false

-i

--insecure

insecure skip verify

Default value: false

--overwrite

this flag is used to overwrite the old profile if the profile for profile name provided already exists

Default value: false

--profile-name

name for the profile of the new api-token

--url

tenant url

-v

--verbose

to show debug logs

Default value: false

chef-node-management-cli set-default-profile

Set default profile for request

Usage

chef-node-management-cli set-default-profile [flags]

Options

-h

--help

help for set-default-profile

Default value: false

chef-node-management-cli status

Commands related to status

Options

-h

--help

help for status

Default value: false

chef-node-management-cli status get-enrollmentId-status

Get node(s) enrollment status using enrollment id

Synopsis

Use this operation to obtain the node(s) enrollment status using enrollment id

Usage

chef-node-management-cli status get-enrollmentId-status [flags]

Options

--enrollmentId

Enrollment Id of node/nodes

--format

to print response in format

Default value: json

-h

--help

help for get-enrollmentId-status

Default value: false

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli status get-status

Get node enrollment status

Synopsis

Use this operation to obtain a node enrollment status

Usage

chef-node-management-cli status get-status [flags]

Options

--format

to print response in format

Default value: json

-h

--help

help for get-status

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli status update-status

update the node enrollment status

Synopsis

Use this operation to update the node enrollment state and status.

Usage

chef-node-management-cli status update-status [flags]

Options

--body

The updated node enrollment status definition

--body-file

Path to file in the local system containing valid body parameter value

--body-format

Format of the --body or --body-file, options: json, yaml, toml

Default value: json

--format

to print response in format

Default value: json

-h

--help

help for update-status

Default value: false

--nodeId

Id of a node

--profile

name of the profile to be used for cmd

Default value: default

--verbose

to show debug logs

Default value: false

chef-node-management-cli version

Chef Platform version

Usage

chef-node-management-cli version [flags]

Options

-h

--help

help for version

Default value: false

chef-node-management-cli reference