Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

ipaddress

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

create

Use ipaddress-create from the command line to acquire a NAT address for a given private IP address of a server for a service.

Note

This command is available in BMC Cloud Lifecycle Management 4.5 patch 3 and later.

Command-line syntax
clm ipaddress-create [-h] [--waitfor TIME_OUT_SECONDS] --servicename NAME 
--ipaddress IP_ADDRESS --acquirenataddress

Note

Only the cloud administrator can acquire an IP address.

The following code snippet shows a sample ipaddress-create SDK call:

Command-line example
ipaddress-create --waitfor -1 --servicename 
4101_QS_Windows-66 --ipaddress 10.4.0.0.6 --acquirenataddress

Use ipaddress_create in the API to acquire a NAT address for a given private IP address of a server for a service. This command returns a NAT IP address object.

API syntax
obj = ipaddress_create(gcac, servicename=None, ipaddress=None, acquirenataddress=None)

obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argumentAPI parameterDescriptionRequired?
--acquirenataddress
acquirenataddress
Flag which indicates that a NAT IP address is to be acquired.Yes
--servicenameserviceName

Name of the service.

Yes
--ipaddressipAddressIP address of one of the servers from the service for which the NAT IP address is to be acquired.Yes
--waitfor 

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

 
 gcacGenericCloudAPIClient instance/user authentication. 

list

Use ipaddress-list from the command line to list IP addresses allocated or used by BMC Cloud Lifecycle Management.

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

Use ipaddress_list in the API to list IP addresses allocated or used by BMC Cloud Lifecycle Management. This command returns a list of IPAddress API objects with the same attributes and relationships.

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

obj[n].guid returns the GUID
obj[n].name returns the name
...
Command-line argumentAPI parameterDescriptionRequired?
-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. 
--filterfiltersFilter the output according to the specified criteria. 
 gcacGenericCloudAPIClient instance/user authentication. 

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.

Comments