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.

service

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

create

Use service-create from the command line to create a service from the specified offering.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-create [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--waitfor TIME_OUT_SECONDS] [--onbehalfuser USERNAME] --offeringname NAME --servicename NAME [--quantity [NUMBER]] --serverusername USERNAME --serverpassword PASSWORD --serverhostprefix SERVERHOSTPREFIX --tenantname NAME

Use service_create in the API to create a service from the specified offering. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_create(gcac, offeringName=None, serviceName=None, quantity=1, userName=None, password=None, hostNamePrefix=None, tenantName=None)

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

Command-line argument

API parameter

Description

Required?

--offeringname
offeringName

Name of the offering to use for the new service.

Yes

--servicename
serviceName

Name of the new service.

Yes

--quantity
quantity

Number of services to create.

Yes

--serverusername
userName

User name with administrator access on the servers to configure.

Yes

--serverpassword
password

Password for the administrator user.

Yes

--serverhostprefix
hostNamePrefix

Hostname prefix to use for all servers created for this service.

Yes

--tenantname
tenantName

Name of the tenant for the new service.

Yes

--onbehalfuser

 

Perform the action as the specified user name.

 

-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 in the value for this parameter.

 

 

gcac

Instance of gcac authentication instance.

 

delete

Use service-delete from the command line to delete the specified service.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-delete [-h] [--waitfor TIME_OUT_SECONDS] --servicename NAME

Use service_delete in the API to delete the specified service. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_delete(gcac, serviceName=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
serviceName

Name of the service to delete.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of gcac authentication instance.

 

list

Use service-list from the command line to list available services.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]]

Use service_list in the API to list available services. This command returns a list of ServiceOfferingInstance API objects with the same attributes and relationships.

API syntax
obj = service_list(gcac)

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 in the value for this parameter.

 

 

gcac

Instance of gcac authentication instance.

 

offboard

Use service-offboard from the command line to offboard the specified service.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-offboard [-h] [--waitfor TIME_OUT_SECONDS] --servicename NAME --retainvm {True,False}

Use service_offboard in the API to offboard the specified service. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_offboard(gcac, serviceName=None, retainVM=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
serviceName

Name of the service to offboard.

Yes

--retainvm
retainVM

Indicate whether to keep the servers for this service enrolled in their provider after the service is offboarded. The value can be True or False.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of gcac authentication instance.

 

onboard

Use service-onboard from the command line to onboard the specified server as a new service.

python com/bmc/cloud/sdk/commandline/clmcmd.py service-onboard [-h] [--waitfor TIME_OUT_SECONDS] --providername NAME --environmentname NAME --offeringname NAME --tenantname NAME --ownername USERNAME --virtualcentername NAME --virtualguestname NAME

Use service_onboard in the API to onboard the specified server as a new service. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_onboard(gcac, tenantName=None, ownerName=None, providerName=None, environmentName=None, offeringName=None, virtualCenterName=None, virtualGuestName=None)

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

Command-line argument

API parameter

Description

Required?

--providername
providerName

Name of the provider of the server.

Yes

--environmentname
environmentName

Name of the environment of the server. To discover the environment name use the environment-list command.

Yes

--offeringname
offeringName

Name of the offering to associate with the new service.

Yes

--tenantname
tenantName

Name of the service owner's tenant.

Yes

--ownername
ownerName

Name of the service owner.

Yes

--virtualcentername
virtualCenterName

Name of the VMWare vCenter host to onboard.

Yes

--virtualguestname
virtualGuestName

Name of the virtual guest or virtual machine to onboard.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of gcac authentication instance.

 

refresh

Use service-refresh from the command line to synchronize the states of all servers in the specified service to make them current with their actual configuration.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-refresh [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--waitfor TIME_OUT_SECONDS] --servicename NAME

Use service_refresh in the API to synchronize the states of all servers in the specified service to make them current with their actual configuration. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_refresh(gcac, service_name=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
service_name

Name of the service to refresh.

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 in the value for this parameter.

 

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of gcac authentication instance.

 

start

Use service-start from the command line to start the specified service and all of its servers.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-start [-h] [--waitfor TIME_OUT_SECONDS] --servicename NAME

Use service_start in the API to start the specified service and all of its servers. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_start(gcac, serviceName=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
serviceName

Name of the service to start.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of gcac authentication instance.

 

stop

Use service-stop from the command line to stop the specified service and all of its servers.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-stop [-h] [--waitfor TIME_OUT_SECONDS] --servicename NAME

Use service_stop in the API to stop the specified service and all of its servers. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_stop(gcac, serviceName=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
serviceName

Name of the service to stop.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of the gcac authentication instance.

 

transfer

Use service-transfer from the command line to transfer ownership of a service to another user.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-transfer [-h] [--waitfor TIME_OUT_SECONDS] --servicename NAME --touser USERNAME --totenant NAME

Use service_transfer in the API to transfer ownership of a service to another user. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_transfer(gcac, service_name=None, to_user=None, to_tenant=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
service_name

Name of the service to transfer.

Yes

--touser
to_user

User name of the new owner.

Yes

--totenant
to_tenant

Name of the new owner's tenant.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of the gcac authentication instance.

 

update-option

Use service-update-option from the command line to update a service with the specified option.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py service-update-option [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--waitfor TIME_OUT_SECONDS] --servicename NAME --servername NAME --optionname NAME --optionchoicename NAME

Use service_update in the API to update a service with the specified option. This command returns a ServiceOfferingInstance API object with the same attributes and relationships.

API syntax
obj = service_update(gcac, service_name=None, server_name=None, option_name=None, option_choice_name=None)

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

Command-line argument

API parameter

Description

Required?

--servicename
service_name

Name of the service to update.

Yes

--servername
server_name

Name of the server to update.

Yes

--optionname
option_name

Name of the option to add or update

Yes

--optionchoicename
option_choice_name

A choice available in the specified option.

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 in the value for this parameter.

 

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

Instance of the gcac authentication instance.

 

 

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