This API has a deprecated equivalent from v7.0U1.
List CLI Command
Returns the identifiers of all commands, or commands in a specific namespace.
Request
URLURL
https://{api_host}/api/vapi/metadata/cli/command
Query Parameters
Query Parameters
string
path
Optional
The dot-separated path of the namespace for which command identifiers should be returned. If unset identifiers of all commands registered with the infrastructure will be returned.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
MetadataCliCommandIdentity
of type application/json
Identifiers of the requested commands.
[
{
"name": "string",
"path": "string"
}
]
string
name
Required
Name of the command.
string
path
Required
The dot-separated path of the namespace containing the command in the CLI command tree.
Errors
404
com.vmware.vapi.std.errors.not_found : if a namespace corresponding to path doesn’t exist.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListMetadataCliCommand -Path "MyPath"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/cli/command
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/vapi/metadata/cli/command
x-vmw-doc-operation: list
Availability
Added in 7.0U2
