ipaddress
This topic describes the verb, 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.
--ipaddress IP_ADDRESS --acquirenataddress
The following code snippet shows a sample ipaddress-create SDK call:
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.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--acquirenataddress | acquirenataddress | Flag which indicates that a NAT IP address is to be acquired. | Yes |
{{code language="none"}} --servicename {{/code}} | {{code language="none"}} serviceName {{/code}} | Name of the service. | Yes |
{{code language="none"}} --ipaddress {{/code}} | {{code language="none"}} ipAddress {{/code}} | IP 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. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
delete
Use ipaddress-delete from the command line to release a given NAT address of a server for a service.
--ipaddress IP_ADDRESS --releasenataddress --force
The following code snippet shows a sample ipaddress-delete SDK call:
--ipaddress 1.2.3.1 --releasenataddress --force
Use ipaddress_delete in the API to release a given NAT address of a server for a service. This command returns a NAT IP address object .
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--releasenataddress | releasenataddress | Flag which indicates that a given NAT IP address is to be released. | Yes |
{{code language="none"}} --servicename {{/code}} | {{code language="none"}} serviceName {{/code}} | Name of the service. | Yes |
{{code language="none"}} --ipaddress {{/code}} | {{code language="none"}} ipAddress {{/code}} | NAT IP address to be released. | Yes |
--waitfor |
| Time in seconds to wait for response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
list
Use ipaddress-list from the command line to list IP addresses allocated or used by BMC Cloud Lifecycle Management.
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.
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. |
|