This topic contains information about the container utilities script that is used to test a new container blueprint that you created before you use the container blueprint to create containers in BMC Cloud Lifecycle Management and examples of using these scripts.
Note
Use the BMC Cloud Lifecycle Management utilities to create, configure, or delete containers and provision or decommission Network Interface Controllers (NICs).
About the container utilities script
The container utilities script can be used to provision, modify, and deprovision a container and add or remove a NIC, without involving BMC Cloud Lifecycle Management. This can be helpful when testing out a new container blueprint.
The container utilities are installed with BMC Network Automation. Before using them, expand the BCAN_HOME\public\bmc\bca-networks\extras\bcan-pcm-utility-v.r.mm.zip file into any convenient directory. For consistency with other utilities, expand the file into the BCAN_DATA directory.
Expanding this file creates a bcan-pcm-utility subdirectory structure. The utility scripts are:
- (Windows) bcan-pcm-utility\bin\container-util.bat
- (Linux) bcan-pcm-utility/bin/container-util.sh
These scripts have the options listed in the following table.
Note
Arguments must be enclosed in quotation marks (") if they contain one or more spaces, for example, -zoneName "Zone 1". Quotation marks are optional.
Click here to view the Container utility script options.
| |
|---|
| Displays a list of all the operations supported by the utility |
| Displays help for the specified operation |
| Specifies the hypervisor switch node name |
| Specifies a list of additional parameters in name:value pairs format separated by a comma delimiter
For example, transactionId:asdasd-5465-fghfg,nicId:1,hostname:server1 |
| Specifies the attach point name |
-containerBlueprintName arg | Specifies the container blueprint name |
| Specifies the container name |
| Indicates whether to ignore errors when unconfiguring devices and proceeding to release resources and deleting the container
Valid values: true, false (default) |
-externalNetworkSegmentOverrides arg | Specifies the external network segment overrides, which are of the format:
componentname:flag (true or false)with pairs separated by a comma delimiter.
For example, "name1:true,name2:false" |
| Specifies the firewall overrides, which are of the format: componentname:flag (true or false) with pairs separated by a comma delimiter
For example: "name1:true,name2:false,name3:true" |
-ignoreModifyErrorsFlag arg | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container Valid values: true, false (default) |
-ignoreUnmodifyErrorsFlag arg | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container Valid values: true, false (default) |
-loadBalancerOverrides arg | Specifies the load balancer overrides, which are of the format: componentname:flag (true or false) with pairs separated by a comma delimiter |
| Specifies the address value, which is required for the acquire_virtual_server_nic_address operation |
| Specifies the NIC name, which is required for the acquire_virtual_server_nic_address and release_virtual_server_nic_address operations |
| Specifies the NIC segment overrides, which are of the format: componentname:flag (true or false) with pairs separated by a comma delimiter
For example, "name1:true,name2:false". |
| Specifies the NIC server name, which is required for the acquire_virtual_server_nic_address and release_virtual_server_nic_address operations |
| Specifies the name of operation. The operation name can be one of the following strings: - acquire_nat_address
- acquire_virtual_server_nic_address
- deprovision_container
- describe_incompatibility
- get_compatible_blueprints
- modify_container
- provision_container
- release_all_server_nic_addresses
- release_nat_address
- release_virtual_server_nic_address
- reprovision_container
|
| Specifies the BMC Network Automation application server password corresponding to the user name parameter |
| |
-privateNatAddressValue arg | Specifies the private NAT address value, which is required for the acquire_nat_address operation |
-publicNatAddressValue arg | Specifies the Public NAT address value, which is required for the release_nat_address operation |
| Indicates whether a DNS operation should be performed If this option is set to true, DNS operation is performed for the acquire_virtual_server_nic_address operation. Valid values: true, false (default) |
-releaseOnFailureFlag arg | Indicates whether a NAT address should be released from a pool even when a failure occurs Valid values: true, false (default) |
-restrictedReprovisioningFlag arg
| Indicates whether non-reversible content should be added during container reprovisioning.
By default, only reversible content can be added during reprovisioning. Valid values: true (default), false |
| Specifies a list of runtime parameters, which are of the format name:value with pairs separated by a comma delimiter
For example, runtime.name1:val1,runtime.name2:val2,runtime.name3:val3. You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether BMC Network Automation should skip the actual acquire_xx_address or release_xx_address operation on the IPAM system. Valid values: true, false (default) This option is applicable to the following operations: - acquire_nat_address (when the address is already known)
- acquire_virtual_server_nic_address (when the address is already known)
- release_all_server_nic_addresses
- release_nat_address
- release_virtual_server_nic_address
|
| Indicates whether to skip the attempt to unmodify what was modified in the container Valid values: true, false (default) |
| Specifies the BMC Network Automation application server URL |
| Specifies the BMC Network Automation application server user name |
| Prints the detailed error stack trace |
| |
Back to top
Examples of container utilities script
The following topics describe the usage of the container utilities script.
The following command shows an example to view all the operations supported by the utility. You can run the command from the command line in the directory that contains the utility, or enter the directory as a prefix to the command.
Example
(Windows) C:\BCA-Networks-Data>bcan-pcm-utility\bin>container-util.bat -?
(Linux) hostname:/opt/bmc/bca-networks/public/bmc/bca-networks/extras/bcan-pcm-utility/bin # ./container-util.sh -?
//The output appears as follows:
usage: container-util.[sh/bat]
-? container-util -operation <operation-name> -<option> <option-value>
The following values are allowed for <operation-name>:
acquire_nat_address
acquire_virtual_server_nic_address
deprovision_container
describe_incompatibility
get_compatible_blueprints
modify_container
provision_container
release_all_server_nic_addresses
release_nat_address
release_virtual_server_nic_address
reprovision_container
Run "container-util -help <operation-name>" for details about the
supported <option> arguments for a given operation.
Run the following command to view the help for the get_compatible_blueprints operation:
Example
(Windows) >container-util.bat -help get_compatible_blueprints
(Linux) #./container-util.sh -help get_compatible_blueprints
//The output appears as follows:
usage: container-util.[sh/bat]
-? Display Help
-operation <arg> Name of operation
-password <arg> BNA Server Password
-podName <arg> Pod name
-url <arg> BNA Server URL
-user <arg> BNA Server UserName
-v Prints detailed error stack trace
The following examples illustrate the usage of the container utilities script:
To acquire next available NAT address - acquire_nat_address
You can use the following parameters with the acquire_nat_address operation:
| |
|---|
| |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the container name |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
-privateNatAddressValue <arg> | Specifies the private NAT address value |
-publicNatAddressValue <arg> | Specifies the public NAT address value
This parameter is applicable to acquire_nat_address (when the public address is already known) and release_nat_address. |
| Indicates whether DNS registration is required
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address. |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation acquire_nat_address -containerName LargeGoldContainer1 -privateNatAddressValue 12.3.0.36 -additionalParams "transactionId:iuyuy-kklljl-9988,nicId:7"
Note
The acquire_nat_address operation does not support the DNS operation in BMC Network Automation, therefore set registerDnsFlag to false.
Back to top
To acquire a particular NAT address - acquire_nat_address
You can use the following parameters with the acquire_nat_address operation:
Click here to view the paramters that you can use for the acquire_nat_address operation.
| |
|---|
| |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the container name |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
-privateNatAddressValue <arg> | Specifies the private NAT address value |
-publicNatAddressValue <arg> | Specifies the public NAT address value
This parameter is applicable to acquire_nat_address (when the public address is already known) and release_nat_address. |
| Indicates whether DNS registration is required
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address. |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation acquire_nat_address -containerName LargeGoldContainer1 -privateNatAddressValue 172.17.10.6 -publicNatAddressValue 10.0.0.2 -skipIPAMOperation false -v
Back to top
To provision a NIC to acquire a particular IP address - acquire_virtual_server_nic_address
You can use the following parameters with the acquire_virtual_server_nic_address operation:
| |
|---|
| |
| Specifies the hypervisor switch node name |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the attach point name |
| Specifies the container name |
| Specifies the NIC address value (when the address is already known) |
| Specifies the NIC name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the NIC server name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Indicates whether DNS registration is required
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address. |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation acquire_virtual_server_nic_address -containerName LargeGoldContainer -nicName NIC-1 -nicServerName NICServer1 -attachPointName "Customer Port Type 1" -accessSwitchName Access -nicAddressValue 14.0.3.13 -skipIPAMOperation true -v
Back to top
To provision a NIC to acquire the next available address - acquire_virtual_server_nic_address
You can use the following parameters with the acquire_virtual_server_nic_address operation:
Click here to view the paramters that you can use for the acquire_virtual_server_nic_address operation.
| |
|---|
| |
| Specifies the hypervisor switch node name |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the attach point name |
| Specifies the container name |
| Specifies the NIC address value (when the address is already known) |
| Specifies the NIC name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the NIC server name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Indicates whether DNS registration is required
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address. |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation acquire_virtual_server_nic_address -containerName LargeGoldContainer -nicName NIC-1 -nicServerName NICServer1 -attachPointName "Customer Port Type 1" -accessSwitchName Access -registerDnsFlag true -additionalParams "transactionId:iuyuy-kklljl-9988,nicId:7" –v
Back to top
You can use the following parameters with the deprovision_container operation:
| |
|---|
| |
| Specifies the container name |
-deleteOnFailureFlag
<arg> | Indicates whether to ignore errors when unconfiguring devices and proceeding to release resources and deleting the container
Valid values: true/false (default) |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation deprovision_container -containerName LargeGoldContainer -v
Back to top
To describe incompatibilities in a given container's blueprint - describe_incompatibility
You can use the following parameters with the describe_incompatibility operation:
| |
|---|
| |
-containerBlueprintName
<arg> | Specifies the container blueprint name. This parameter can oan optionally include the revision number, <blueprint-name>#<revision-num> |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation describe_incompatibility -podName LargePod -containerBlueprintName "Large Gold Container Blueprint" -v
Back to top
To get compatible blueprint(s) for a given pod - get_compatible_blueprints
You can use the following parameters with the get_compatible_blueprints operation:
| |
|---|
| |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation get_compatible_blueprints -podName LargePod -v
Back to top
To modify container by overriding an external network segment component - modify_container
You can use the following parameters with the modify_container operation:
| |
|---|
| |
| Specifies the container name |
-externalNetworkSegmentOverrides
<arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag
<arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container. You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer -externalNetworkSegmentOverrides ExternalNetwork:true
Back to top
To modify container by overriding a load balancer component - modify_container
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer -loadBalancerOverrides LoadBalancer1:true
Back to top
To modify container by overriding a firewall component - modify_container
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer -firewallOverrides Firewall1:true
Back to top
To modify container by overriding a NIC segment component - modify_container
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container –containerName LargeGoldContainer -nicSegmentOverrides NIC1:true
Back to top
To modify container by overriding an address pool - modify_container
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer
Do you want to override dynamic addressing components [y/N]: y
Do you want to specify address space overrides [y/N]: n
Do you want to specify address pool overrides [y/N]: y
Enter pool name (specify link id separated by '#'): Customer
*Optional if specifying DNS Info
Enter pool size (optional* see above): 24
Do you want to specify/override DNS Information? [y/N]: n
Do you want to specify address pool overrides [y/N]: n
Back to top
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer
Do you want to override dynamic addressing components [y/N]: y
Do you want to specify address space overrides [y/N]: n
Do you want to specify address pool overrides [y/N]: y
Enter pool name (specify link id separated by '#'): Customer
*Optional if specifying DNS Info
Enter pool size (optional* see above):
Do you want to specify/override DNS Information? [y/N]: y
Warning:
If you are updating DNS Information for an address pool with some addresses that
are acquired and registered with a DNS, review the address pool details before
proceeding. Review the information in the Container view > Address Pool details
popup.
Do you wish to overwrite the existing DNS information? [y/N]: y
Enter primary DNS server name: 10.128.251.14
Enter reverse DNS server name: 10.128.251.14
Enter secondary DNS server name: 10.128.251.15
*Note - Primary DNS domain suffix is required for DNS registration.
Enter primary DNS domain suffix: dnsbind.com
Enter domain search order (comma separated): dnsbind.com, bind.com
Enter reverse DNS zone name: 60.10.in-addr.arpa
Do you want to specify address pool overrides [y/N]: n
Back to top
To modify container by overriding an address space - modify_container
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer -v
Do you want to override dynamic addressing components [y/N]: y
Do you want to specify address space overrides [y/N]: y
*Optional if specifying DNS Info
Enter network address (optional* see above): 45.0.0.0
Enter network mask (dotted decimal/CIDR & optional* see above): 255.255.255.0
Do you want to specify public flag [y/N]: N
Do you want to specify address space name [y/N]: y
Enter address space name: Public
Do you want to specify/override DNS Information? [y/N]: N
Do you want to specify address space overrides [y/N]:n
Back to top
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer -v
Do you want to override dynamic addressing components [y/N]: y
Do you want to specify address space overrides [y/N]: y
*Optional if specifying DNS Info
Enter network address (optional* see above):
Enter network mask (dotted decimal/CIDR & optional* see above):
Do you want to specify public flag [y/N]: N
Do you want to specify address space name [y/N]: y
Enter address space name: Public
Do you want to specify/override DNS Information? [y/N]: y
Enter primary DNS server name: 10.128.251.12
Enter reverse DNS server name: 20.121.35.80
Enter secondary DNS server name: 10.128.251.15
*Note - Primary DNS domain suffix is required for DNS registration. Enter primary DNS domain suffix: dnsbind.com Enter domain search order (comma separated): dnsbind.com Enter reverse DNS zone name: 90.in-addr.arpa Do you want to specify address space overrides [y/N]:n
Back to top
To modify container by overriding an external network - modify_container
You can use the following parameters with the modify_container operation:
Click here to view the paramters that you can use for the modify_container operation.
Parameter | Description |
|---|
| Displays Help |
| Specifies the container name |
-externalNetworkSegmentOverrides <arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreModifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-ignoreUnmodifyErrorsFlag <arg> | Indicates whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides <arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides <arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:value2, runtime.name3:val3"
This parameter is applicable to provision_container, modify_container, and reprovision_container.You can specify up to 255 characters in the runtime parameter value. |
| Indicates whether to skip the attempt to unmodify what was modified in the container
Valid vales: true/false (default) |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation modify_container -containerName LargeGoldContainer
Do you want to override dynamic addressing components []: y
Do you want to specify address space overrides []: n
Do you want to specify address pool overrides []: n
Do you want to specify external network segment overrides []: y
Enter external network segment name: OUTSIDE
Enter network address: 45.0.0.0
Enter network mask (dotted decimal): 255.255.255.0
Note
You can specify runtime parameters with values and the following flags with the value true or false as needed while using the modify_container operation.
- ignoreModifyErrorsFlag: Flags whether to ignore errors that occur while reconfiguring devices during the attempt and update the resources in the container.
- skipUnmodifyFlag: Flags whether to skip the attempt to unmodify what was modified.
- ignoreUnmodifyErrorsFlag: Flags whether to ignore errors that occur while reconfiguring devices during the unmodify attempt, and update the resources in the container.
Back to top
To create containers after successful pod creation - provision_container
You can use the following parameters with the provision_container operation:
| |
|---|
| |
-containerBlueprintName <arg> | Specifies the container blueprint name. Can optionally include the revision number, <blueprint-name>#<revision-num> |
| Specifies the container name |
-externalNetworkSegmentOverrides
<arg> | Specifies the external network segment overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the firewall overrides
Valid values: true/false
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-loadBalancerOverrides
<arg> | Specifies the load balancer overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
-nicSegmentOverrides
<arg> | Specifies the NIC segment overrides
Valid values: true/false (default)
Format: componentname:flag (true/false) with pairs separated by comma delimiter
Example: "name1.true,name2:false,name3:true" |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| |
| Specifies a list of runtime parameters
Format: name:value with pairs separated by comma delimiter
Example: "runtime.name1:val1,runtime.name2:val2,runtime.name3:val3""
This parameter is applicable to provision_container, modify_container, and reprovision_container. You can specify up to 255 characters in the runtime parameter value. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation provision_container -podName LargePod -containerName LargeGoldContainer -containerBlueprintName "Large Gold Container Blueprint" -v
Notes
- If the guest device created or reused in the container has the ${container.name} substitution parameter in its name, ensure the following naming conventions:
- The length of the container name does not exceed the maximum configurable value allowed by the device. For details about the vdcMaxVirtualGuestFullNameLength property, see Default-global-properties-file.
- The guestDeviceName does not contain certain special characters. For details see, Container blueprint XML reference.
- When you create a container, if you want to use a round robin methodology to select a pod node instead of the default capacity methodology, you must change the value of the BMC Network Automation global property, roundrobinPodNodeSelection, to true. You can also use the round robin methodology to select pod node pairs for a container by changing the value of the BMC Network Automation global property, roundrobinPodPairSelection, to true. See Default-global-properties-file.
- In versions earlier than 8.7.00, the Version attribute of a container displays the legacy version of the container blueprint. Starting from version 8.7.00, the Version attribute displays the version of the BMC Network Automation system in which the container is created, irrespective of legacy version of the container blueprint.
Back to top
To decommission all NICs of a particular NIC server - release_all_server_nic_addresses
You can use the following parameters with the release_all_server_nic_addresses operation:
| |
|---|
| |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the container name |
| Specifies the NIC server name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation release_all_server_nic_addresses -containerName LargeGoldContainer -nicServerName NICServer1 -v {{code language="none"}}
-additionalParams "transactionId:iuyuy-kklljl-9988,nicId:7"
{{/code}}-skipIPAMOperation false -v
Back to top
To release a NAT address from a pool - release_nat_address
You can use the following parameters with the release_nat_address operation:
| |
|---|
| |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the container name |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
-publicNatAddressValue
<arg> | Specifies the public NAT address value
This parameter is applicable to acquire_nat_address (when the public address is already known) and release_nat_address. |
-releaseOnFailureFlag
<arg> | Indicates whether a NAT address should be released from a pool even when a failure occurs
Valid values: true/false (default) |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation release_nat_address -containerName LargeGoldContainer -publicNatAddressValue 12.2.0.3 -releaseOnFailureFlag true -additionalParams "transactionId:iuyuy-kklljl-9988,nicId:7" {{code language="none" source="string:{{code language=~"none~"~}~}
-skipIPAMOperation true
{{/code~}~}"/}}{{/code}}–v
Back to top
To decommission a specified NIC - release_virtual_server_nic_address
You can use the following parameters with the release_virtual_server_nic_address operation:
| |
|---|
| |
| Specifies a list of additional parameters
Format: name:value with pairs separated by comma delimiter
Example: "transactionId:val1,nicId:val2"
This parameter is applicable to acquire_nat_address, acquire_virtual_server_nic_address, release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the container name |
| Specifies the NIC name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the NIC server name
This parameter is applicable to acquire_virtual_server_nic_address and release_virtual_server_nic_address. |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
| Indicates whether BMC Network Automation should skip the actual release_xx_address or release_xx_address operation on the IPAM system
Valid values: true/false (default)
This parameter is applicable to acquire_nat_address and acquire_virtual_server_nic_address when the address is already known, and release_nat_address, release_virtual_server_nic_address, and release_all_server_nic_addresses. |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation release_virtual_server_nic_address -containerName LargeGoldContainer -nicName NIC-1 -nicServerName NICServer1 -additionalParams "transactionId:iuyuy-kklljl-9988,nicId:7" -skipIPAMOperation false - v
Back to top
To reprovision a container - reprovision_container
You can use the following parameters with the reprovision_container operation:
| |
|---|
| |
-containerBlueprintName <arg> | Container blueprint name. This parameter can optionally include the revision number, <blueprint-name>#<revision-num> |
| Specifies the container name |
| Specifies the name of the operation |
| Specifies the BMC Network Automation server password |
-restrictedReprovisioningFlag
<arg> | Indicates whether non-reversible content should be added during container reprovisioning
Valid values: true (default)/false |
| Specifies the BMC Network Automation server URL |
| Specifies the BMC Network Automation server user name |
| Prints detailed error stack trace |
Example
container-util.bat -url https://vw-pun-bna-pt01 -user sysadmin -password sysadmin1 -operation reprovision_container -containerName LargeGoldContainer -containerBlueprintName "Large Gold Container Blueprint" -restrictedReprovisioningFlag false -v
Back to top