vcd-account

This topic describes the verbs, command-line arguments, and API parameters available for the vcd-account noun in the BMC Cloud Lifecycle Management SDK. (This call is available when the provider is defined as VMWare vCloud.)

list

Use vcd-account-list from the command line to list configured VMWare vCloud Director accounts.

Command-line syntax

clm vcd-account-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]]
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]] --provider NAME|id:<GUID>

Use vcd_account_list to list configured VMWare vCloud Director accounts using the API. This command returns a list of LogicalDataCenterUserMap API objects with the same attributes and relationships.

API syntax

obj = vcd_account_list(gcac, provider=None, filters=None, fieldInfo=None)

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

Command-line argument	API parameter	Description	Required?
--provider	provider	Name or GUID of the provider.	Yes
-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.
	fieldInfo	list of OM attributes and relations such as ([‘name’, ‘tags.’, ‘inPool.’])
	gcac	GenericCloudAPIClient instance/user authentication.

map-to

Use vcd-account-map-to from the command line to register a VMWare vCloud Director account.

Command-line syntax

clm vcd-account-map-to [-h] [--waitfor TIME_OUT_SECONDS] --provider NAME|id:<GUID> --username NAME
--tenantname NAME --vcdtenantname NAME|id:<GUID> --vcdusername NAME

Use vcd_account_map in the API to register a VMWare vCloud Director account. This command affects a LogicalDataCenterUserMap API object.

API syntax

obj = vcd_account_map(gcac, provider=None, userName=None, tenantName=None, vcdTenantname=None, vcdUserName=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument	API parameter	Description	Required?
--provider	provider	Name or GUID of the provider.	Yes
--username	userName	BMC Cloud Lifecycle Management account user name.	Yes
--tenantname	tenantName	Name of the tenant in BMC Cloud Lifecycle Management.	Yes
--vcdtenantname	vcdTenantName	Name of the tenant in VMWare vCloud Director.	Yes
--vcdusername	vcdUserName	VMWare vCloud Director account user name.	Yes
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

unmap-to

Use vcd-account-unmap-to from the command line to unregister a VMWare vCloud Director account.

Command-line syntax

clm vcd-account-unmap-to [-h] [--waitfor TIME_OUT_SECONDS] --provider NAME|id:<GUID> --account NAME

Use vcd_account_unmap in the API to unregister a VMWare vCloud Director account. This command affects a LogicalDataCenterUserMap API object.

API syntax

obj = vcd_account_unmap(gcac, provider=None, account=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument	API parameter	Description	Required?
--provider	provider	Name or GUID of the provider.	Yes
--account	account	Account user name.	Yes
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

vcd-account

list

map-to

unmap-to

On this page