Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

host

This topic describes the verb, command-line arguments, and API parameters available for the host noun in the BMC Cloud Lifecycle Management SDK.

list

Use host-list from the command line to list onboarded hosts.

Command-line syntax
clm host-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]

Use host_list in the API to list onboarded hosts. This command returns a list of VirtualHost API objects with the same attributes and relationships.

API syntax
obj = host_list(gcac, filters=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument

API parameter

Description

Required?

-l

 

List all fields. This parameter does not need a value.

 

-u

 

List only GUIDs. This parameter does not need a value.

 

-n

 

List only names. This parameter does not need a value.

 

-s

 

List GUIDs, names, and status (if applicable). This parameter does not need a value.

 

-k

 

List the field names specified as the value for this parameter.

 

--filter
filters

Filter the output according to the specified criteria.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*