subnet
This topic describes the verbs, command-line arguments, and API parameters available for the subnet noun in the BMC Cloud Lifecycle Management SDK.
list
Use subnet-list from the command line to list available subnets.
[-k FIELD_NAME [FIELD_NAME ...]]
Use subnet_list in the API to list available subnets. This command returns a list of LogicalHostingEnvironment 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. |
|
map-to
Use subnet-map-to from the command line to map tags to a subnet.
--subnet NAME --tags GROUP[TAG1,TAG2,...]
Use subnet_map in the API to map tags to a subnet. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--environment | environment | Name or GUID of the environment of the subnet. | Yes |
--subnet | subnet | Name of the subnet. | Yes |
--tags | tagList | Tag or tags to map to the subnet. Any tags or tag groups specified here will be created if they do not already exist. | 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 subnet-unmap-to from the command line to unmap tags from a subnet.
--subnet NAME --tags GROUP[TAG1,TAG2,...]
Use subnet_unmap in the API to unmap tags from a subnet. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Required? | Description |
|---|---|---|---|
--environment | environment | Name or GUID of the environment of the subnet. | Yes |
--subnet | subnet | Name of the subnet. | Yes |
--tags | tagList | Tag or tags to unmap from the subnet. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
update
Use subnet-update from the command line to update subnet details or mark the subnet enabled/disabled.
[--subnetaddress SUBNET] [--subnetmask NETWORK_MASK] [--enable | --disable]
Use subnet_update in the API to update subnet details or mark the subnet enabled/disabled. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--environment | environment | Name or GUID of the environment of the subnet. | Yes |
--subnet | subnet | Name of the subnet. | Yes |
--subnetaddress | subnetAddress | IP address of the subnet. |
|
--subnetmask | subnetMask | The subnet mask |
|
--enable | enable | Enable the subnet. This parameter does not need a value for the command line. For the API, specify true, false, or None. |
|
--disable |
| Disable the subnet. This parameter does not need a value. |
|
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|