- 3.2.1 add network
- 3.2.2 add network-to-tenant-group
- 3.2.3 add server
- 3.2.4 backup
- 3.2.5 configure vhbas
- 3.2.6 create lock
- 3.2.7 create network
- 3.2.8 create tenant-group
- 3.2.9 delete config-error
- 3.2.10 delete lock
- 3.2.11 delete network
- 3.2.12 delete task
- 3.2.13 delete tenant-group
- 3.2.14 diagnose
- 3.2.15 get log
- 3.2.16 list
- 3.2.17 remove network
- 3.2.18 remove network-from-tenant-group
- 3.2.19 remove server
- 3.2.20 reprovision
- 3.2.21 rerun
- 3.2.22 set system-property
- 3.2.23 show
- 3.2.24 start
- 3.2.25 stop
- 3.2.26 update appliance
- 3.2.27 update password
This section describes all of the documented commands available via the CLI.
Connects a server node to an existing network. To create a new custom network, see Section 3.2.7, “create network”.
Syntax
add network
network-name
node
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where network-name
is the name of the network
you wish to connect one or more servers to, and
node
is the name of the server node that should
be connected to the selected network.
Description
Use the add network command to connect the required server nodes to a custom network you created. When you set up custom networks between your servers, you create the network first, and then add the required servers to the network. Use the create network command to configure additional custom networks.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.3 Connecting a Compute Node to a Custom Network
PCA> add networkMyNetwork
ovcacn09r1
Status: Success
Associates a custom network with an existing tenant group. To create a new tenant group, see Section 3.2.8, “create tenant-group”. To create a new custom network, see Section 3.2.7, “create network”.
Syntax
add network-to-tenant-group
network-name
tenant-group-name
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where network-name
is the name of an existing
custom network, and tenant-group-name
is the
name of the tenant group you wish to associate the custom
network with.
Description
Use the add network-to-tenant-group command to connect all member servers of a tenant group to a custom network. The custom network connection is configured when a server joins the tenant group, and unconfigured when a server is removed from the tenant group.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.4 Associating a Custom Network with a Tenant Group
PCA> add network-to-tenant-groupmyPublicNetwork
myTenantGroup
Status: Success
Adds a server to an existing tenant group. To create a new tenant group, see Section 3.2.8, “create tenant-group”.
Syntax
add server
node
tenant-group-name
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where tenant-group-name
is the name of the
tenant group you wish to add one or more servers to, and
node
is the name of the server node that should
be added to the selected tenant group.
Description
Use the add server command to add the required compute nodes to a tenant group you created. If a compute node is currently part of another tenant group, it is first removed from that tenant group. If custom networks are already associated with the tenant group, the newly added server is connected to those networks as well. Use the command add network-to-tenant-group to associate a custom network with a tenant group.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.5 Adding a Compute Node to a Tenant Group
PCA> add server ovcacn09r1 myTenantGroup
Status: Success
Triggers a manual backup of the Oracle Private Cloud Appliance.
The backup command can only be executed from the active management node; not from the standby management node.
Syntax
backup
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
Description
Use the backup command to initiate a backup task outside of the usual cron schedule. The backup task performs a full backup of the Oracle PCA as described in Section 1.6, “Oracle Private Cloud Appliance Backup”. The CLI command does not monitor the progress of the backup task itself, and exits immediately after triggering the task, returning the task ID, its initial status, its progress and start time. This command must only ever be run on the active management node.
You can use the show task command to view the status of the task after you have initiated the backup. See Example 3.41, “Show Task” for more information.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.6 Running a backup task
PCA> backup The backup job has been submitted. Use "show task <task id>" to monitor the progress. Task_ID Status Progress Start_Time Task_Name ------- ------ -------- ---------- --------- 341e7bc74f339c RUNNING None 06-27-2016 09:59:36 backup --------------- 1 row displayed Status: Success
Configures vHBAs on compute nodes.
Syntax
configure vhbas
{
ALL
|
node
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where node
is the compute node name for the
compute node for which the vHBAs should be configured, and
ALL
refers to all compute nodes provisioned in
your environment.
Description
This command creates the default virtual host bus adapters (vHBAs) for fibre channel connectivity, if they do not exist. Each of the four default vHBAs corresponds with a bond on the physical server. Each vHBA connection between a server node and Fabric Interconnect has a unique mapping. Use the configure vhbas command to configure the virtual host bus adapters (vHBA) on all compute nodes or a specific subset of them.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Configure vHBAs for all compute nodes or for one or more specific compute nodes. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.7 Configuring the vHBAs for Specific Compute Nodes
PCA> configure vhbas ovcacn11r1 ovcacn14r1 Compute_Node Status ------------ ------ ovcacn14r1 Succeeded ovcacn11r1 Succeeded ---------------- 2 rows displayed Status: Success
Imposes a lock on certain appliance functionality.
Never use locks without consultation or specific instructions from Oracle Support.
Syntax
create lock
{
all_provisioning
|
database
|
install
|
manufacturing
|
provisioning
|
service
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
Description
Use the create lock command to temporarily disable certain appliance-level functions. The lock types are described in the Options.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Suspend all management node updates and compute node provisioning. Running tasks are completed and stop before the next stage in the process. A daemon checks for locks every few seconds. Once the lock has been removed, the update or provisioning processes continue from where they were halted. |
| Impose a lock on the databases during the management node update process. The lock is released after the update. |
| Placeholder lock type. Currently not used. |
| For usage in manufacturing.
This lock type prevents the first boot process from
initiating between reboots in the factory. As long as
this lock is active, the |
| Prevent compute node provisioning. If a compute node provisioning process is running, it stops at the next stage. A daemon checks for locks every few seconds. Once the lock has been removed, all nodes advance to the next stage in the provisioning process. |
| Placeholder lock type. Behavior is identical to manufacturing lock. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Creates a new custom network, private or public, at the appliance level. See Section 2.6, “Network Customization” for detailed information.
Syntax
create network
network-name
{
rack_internal_network
|
external_network
'ports'
|
host_network
'ports'
prefix
netmask
[route-destination
gateway]
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where network-name
is the name of the custom
network you wish to create.
If the network type is external_network
, then
the Fabric Interconnect ports where the network
terminates must also be specified as 'ports'
.
If the network type is host_network
, then
additional arguments are expected. The subnet agruments are
mandatory; the routing arguments are optional.
prefix
: defines the fixed part of the host network subnet, depending on the netmasknetmask
: determines which part of the subnet is fixed and which part is variable[route-destination]
: the external network location reachable from within the host network, which can be specified as a single valid IPv4 address or a subnet in CIDR notation.[gateway]
: the IP address of the gateway for the static route, which must be inside the host network subnet
The IP addresses of the hosts or physical servers are based on the prefix and netmask of the host network. The final octet is the same as the corresponding internal management IP address. The routing information from the create network command is used to configure a static route on each compute node that joins the host network.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
{
| The type of custom network to create. The options are:
|
|
To create a custom network with external connectivity,
you must specify the ports on the
Fabric Interconnect as well. Ports are
identified by their I/O module number and port number,
separated by a colon. Put the port identifiers between
quotes as a space-separated list, for example:
|
|
To create a custom host network, you must specify the
ports on the Fabric Interconnect as with an
external network. Ports are identified by their I/O
module number and port number, separated by a colon.
Put the port identifiers between quotes as a
space-separated list, for example: In addition, the host network requires arguments for its subnet. The routing arguments are optional. All four arguments are explained in the Syntax section above. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.9 Creating an Internal Custom Network
PCA> create network MyPrivateNetwork
rack_internal_network
Status: Success
Example 3.10 Creating a Custom Network with External Connectivity
PCA> create network MyPublicNetwork
external_network '4:2 5:2'
Status: Success
Creates a new tenant group. With the tenant group, which exists at the appliance level, a corresponding Oracle VM server pool is created. See Section 2.7, “Tenant Groups” for detailed information.
Syntax
create tenant-group
tenant-group-name
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where tenant-group-name
is the name of the
tenant group – and server pool – you wish to add to the
environment.
Description
Use the create tenant-group command to set up a new placeholder for a separate group of compute nodes. The purpose of the tenant group is to group a number of compute nodes in a separate server pool. When the tenant group exists, add the required servers using the add server command. If you want to connect all the members of a server pool to a custom network, use the command add network-to-tenant-group.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
The delete config-error command can be used to delete a failed configuration task from the configuration error database.
Syntax
delete config-error
id
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where id
is the identifier for the
configuration error that you wish to delete from the database.
Description
Use the delete config-error command to remove
a configuration error from the configuration error database.
This is a destructive operation and you are prompted to confirm
whether or not you wish to continue, unless you use the
--confirm
flag to override the prompt.
Once a configuration error has been deleted from the database, you may not be able to re-run the configuration task associated with it. To obtain a list of configuration errors, use the list config-error command. See Example 3.31, “List All Configuration Errors” for more information.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.12 Removing a Configuration Error
PCA> delete config-error 87 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
Removes a lock that was previously imposed on certain appliance functionality.
Syntax
delete lock
{
all_provisioning
|
database
|
install
|
manufacturing
|
provisioning
|
service
} [
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
Description
Use the delete lock command to re-enable the appliance-level functions that were locked earlier.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
{
| The type of lock to be removed. For a description of lock types, see Section 3.2.6, “create lock”. |
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.13 Unlocking Provisioning
PCA> delete lock provisioning ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
Deletes a custom network. See Section 2.6, “Network Customization” for detailed information.
Syntax
delete network
network-name
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where network-name
is the name of the custom
network you wish to delete.
Description
Use the delete network command to remove a
previously created custom network from your environment. This is
a destructive operation and you are prompted to confirm whether
or not you wish to continue, unless you use the
--confirm
flag to override the prompt.
A custom network can only be deleted after all servers have been removed from it. See Section 3.2.17, “remove network”.
Default Oracle PCA networks are protected and any attempt to delete them will fail.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.14 Deleting a Custom Network
PCA> delete network MyNetwork
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: Success
Example 3.15 Attempting to Delete a Default Network
PCA> delete network vm_private Status: Failure Error Message: Error (NETWORK_003): Exception while deleting network: vm_private. ['INVALID_NAME_002: Invalid Network name: vm_private. Name is reserved.']
The delete command can be used to delete a task from the database.
Syntax
delete task
id
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where id
is the identifier for the task that
you wish to delete from the database.
Description
Use the delete task command to remove a task
from the task database. This is a destructive operation and you
are prompted to confirm whether or not you wish to continue,
unless you use the --confirm
flag to override
the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.16 Removing a Task
PCA> delete task 341e7bc74f339c ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
Deletes a tenant group. The default tenant group cannot be deleted. See Section 2.7, “Tenant Groups” for detailed information.
Syntax
delete tenant-group
tenant-group-name
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where tenant-group-name
is the name of the
tenant group – and server pool – you wish to add to the
environment.
Description
Use the delete tenant-group command to remove a previously created, non-default tenant group from your environment. All servers must be removed from the tenant group before it can be deleted. When the tenant group is deleted, the server pool file system is removed from the internal ZFS storage and the virtual IP address becomes available for re-use by another tenant group.
This is a destructive operation and you are prompted to confirm
whether or not you wish to continue, unless you use the
--confirm
flag to override the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.17 Deleting a Tenant Group
PCA> delete tenant-group myTenantGroup
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: Success
Performs various diagnostic checks against the Oracle Private Cloud Appliance for support purposes.
Syntax
diagnose
{
ilom
|
software
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
Description
Use the diagnose command to initiate a diagnostic check of various components that make up Oracle PCA.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
{
|
Specify the type of diagnostic check that should be
performed as the command target. The
|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.18 Running the ILOM Diagnostic
PCA> diagnose ilom Checking ILOM health............please wait.. IP_Address Status Health_Details ---------- ------ -------------- 192.168.4.129 Not Connected 192.168.4.128 Not Connected 192.168.4.127 Not Connected 192.168.4.126 Not Connected 192.168.4.125 Not Connected 192.168.4.124 Not Connected 192.168.4.123 Not Connected 192.168.4.122 Not Connected 192.168.4.121 Not Connected 192.168.4.120 Not Connected 192.168.4.101 OK 192.168.4.102 OK 192.168.4.105 Faulty Mon Nov 25 14:17:37 2013 Power PS1 (Power Supply 1) A loss of AC input to a power supply has occurred. (Probability: 100, UUID: 2c1ec5fc-ffa3-c768-e602-ca12b86e3ea1, Part Number: 07047410, Serial Number: 476856F+1252CE027X, Reference Document: http://www.sun.com/msg/SPX86-8003-73) 192.168.4.107 OK 192.168.4.106 OK 192.168.4.109 OK 192.168.4.108 OK 192.168.4.112 OK 192.168.4.113 Not Connected 192.168.4.110 OK 192.168.4.111 OK 192.168.4.116 Not Connected 192.168.4.117 Not Connected 192.168.4.114 Not Connected 192.168.4.115 Not Connected 192.168.4.118 Not Connected 192.168.4.119 Not Connected ----------------- 27 rows displayed Status: Success
Example 3.19 Running the Software Diagnostic
PCA> diagnose software PCA Software Acceptance Test runner utility Test - 701 - OpenSSL CVE-2014-0160 Heartbleed bug Acceptance [PASSED] Test - 785 - PCA package Acceptance [PASSED] Test - 1083 - Mgmt node xsigo network interface Acceptance [PASSED] Test - 787 - Shared Storage Acceptance [PASSED] Test - 973 - Simple connectivity Acceptance [PASSED] Test - 1078 - Test for ovs-agent service on CNs Acceptance [PASSED] Test - 1079 - Test for shares mounted on CNs Acceptance [PASSED] Test - 1080 - ovs-log check Acceptance [PASSED] Test - 788 - PCA services Acceptance [PASSED] Test - 789 - PCA config file Acceptance [PASSED] Test - 1300 - All compute nodes running Acceptance [PASSED] Test - 1318 - Check support packages in PCA image Acceptance [PASSED] Test - 928 - Repositories defined in OVM manager Acceptance [PASSED] Test - 1107 - Compute node xsigo network interface Acceptance [PASSED] Test - 1316 - PCA version Acceptance [PASSED] Test - 1117 - Network interfaces check Acceptance [PASSED] Test - 824 - OVM manager settings Acceptance [PASSED] Test - 927 - OVM server model Acceptance [PASSED] Test - 925 - PCA log Acceptance [PASSED] Test - 926 - Networks defined in OVM manager for CNs Acceptance [PASSED] Test - 822 - Compute node network interface Acceptance [PASSED] Status: Success
Retrieves the log files from the selected components and saves them to a temporary directory.
Currently the Oracle Fabric Interconnect F1-15 is the only target component supported with this command.
Syntax
get log
component
[
--confirm
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where component
is the identifier of the rack
component from which you want to retrieve the log files.
Description
Use the get log command to collect the log files of a given rack component or set of rack components of a given type. The command output indicates where the log files are saved: this is a the temporary directory on the management node where you run the command. From this location you can examine the logs or copy them to your local system so they can be included in your communication with Oracle.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.20 Collecting the Log Files from the Fabric Interconnects
Note that the CLI uses 'xsigo' as the internal alias for an Oracle Fabric Interconnect F1-15.
PCA> get log xsigo Log files to be found: /tmp/xsigo-log* Status: Success
The list command can be used to list the different components and tasks within the Oracle PCA. The output displays information relevant to each component or task. Output from the list command is usually tabulated so that different fields appear as columns for each row of information relating to the command target.
Syntax
list
{
compute-node
|
config-error
|
lock
|
management-node
|
network
|
network-card
|
network-port
|
ofm-network
|
opus-port
|
server-profile
|
storage-network
|
task
|
tenant-group
|
update-task
|
wwpn-info
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
] [
[
--sorted-by SORTEDBY
|
--sorted-order SORTEDORDER
]
] [
[
--filter-column FILTERCOLUMN
|
--filter FILTER
]
]
where
is
one of the table column names returned for the selected command
target, and
SORTEDBY
can be
either SORTEDORDER
ASC
for an ascending sort, or
DES
for a descending sort. See
Section 3.1.3.2, “Sorting” for more
information.
where
is one of the table column names returned for the selected
command target, and
FILTERCOLUMN
is the text
that you wish to match to perform your filtering. See
Section 3.1.3.3, “Filtering” for more
information.
FILTER
The following table describes each possible target of the list command.
Command Target | Information Displayed |
---|---|
compute-node | Displays basic information for all compute nodes installed. |
config-error | Displays all configuration tasks that were not completed successfully and ended in an error. |
lock | Displays all locks that have been imposed. |
management-node | Displays basic information for both management nodes. |
network | Displays all networks configured in the environment. |
network-card | Displays information about the I/O modules installed in the Fabric Interconnects. |
network-port | Displays the status of all ports on all I/O modules installed in the Fabric Interconnects. |
ofm-network | Displays network configuration, read directly from the Oracle Fabric Manager software on the Fabric Interconnects. |
opus-port | Displays connection information about every port of every Oracle Switch ES1-24 in the Oracle PCA environment. |
server-profile | Displays a list of connectivity profiles for servers, as stored by the Fabric Interconnects. The profile contains essential networking and storage information for the server in question. |
storage-network | Displays a list of known storage clouds. The configuration of each storage cloud contains information about participating Fabric Interconnect ports and server vHBAs. |
task | Displays a list of running, completed and failed tasks. |
tenant-group | Displays all configured tenant groups. The list includes the default configuration as well as custom tenant groups. |
update-task | Displays a list of all software update tasks that have been started on the appliance. |
wwpn-info | Displays a list of all World Wide Port Names (WWPNs) for all ports participating in the Oracle PCA Fibre Channel fabric. In the standard configuration each compute node has a vHBA in each of the four default storage clouds. |
Note that you can use tab completion to help you correctly
specify the object
for the different command
targets. You do not need to specify an object
if the command target is system-properties
or
version
.
Description
Use the list command to obtain tabulated listings of information about different components or activities within the Oracle PCA. The list command can frequently be used to obtain identifiers that can be used in conjunction with many other commands to perform various actions or to obtain more detailed information about a specific component or task. The list command also supports sorting and filtering capabilities to allow you to order information or to limit information so that you are able to identify specific items of interest quickly and easily.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
{
| The command target to list information for. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
[
--sorted-by |
Sort the table by the values within a particular
column in the table, specified by replacing
|
[
--sorted-order |
Used to specify the sort order, which can either be
|
[
--filter-column |
Filter the table for a value within a particular
column in the table, specified by replacing
|
[
--filter |
The filter that should be applied to values within the
column specified by the
|
When the target of the list command is
either management-node
or
compute-node
, the Node_State column is used
to show the software completeness of a node through the
provisioning process. It does not indicate the system status
of a node.
Examples
Example 3.21 List all management nodes
PCA> list management-node Management_Node IP_Address Provisioning_Status ILOM_MAC Provisioning_State Master --------------- ---------- ------------------- -------- ------------------ ------ ovcamn05r1 192.168.4.3 RUNNING 00:10:e0:65:30:5f running Yes ovcamn06r1 192.168.4.4 RUNNING 00:10:e0:65:30:65 running None ---------------- 2 rows displayed Status: Success
Example 3.22 List all compute nodes
PCA> list compute-node Compute_Node IP_Address Provisioning_Status ILOM_MAC Provisioning_State ------------ ---------- ------------------- -------- ------------------ ovcacn10r1 192.168.4.7 RUNNING 00:10:e0:65:2f:4b running ovcacn08r1 192.168.4.5 RUNNING 00:10:e0:65:2f:f3 initializing_stage_wait_... ovcacn09r1 192.168.4.10 RUNNING 00:10:e0:62:98:e3 running ovcacn07r1 192.168.4.8 RUNNING 00:10:e0:65:2f:93 running ---------------- 4 rows displayed Status: Success
Example 3.23 List All Tenant Groups
PCA> list tenant-group Name Default State ---- ------- ----- Rack1_ServerPool True ready myTenantGroup False ready ---------------- 2 rows displayed Status: Success
Example 3.24 List Appliance Networks
PCA> list network Network_Name Trunkmode Description ---------- --------- ----------- vm_public_vlan True 2014-07-12 02:11:27 mgmt_public_eth True 2014-07-12 02:09:42 mgmt_pvi False 2014-07-12 02:08:38 vm_private False 2014-07-12 02:10:35 discovered-network False ---------------- 5 rows displayed Status: Success
Example 3.25 List the Network Ports Configured on the Fabric Interconnects
PCA> list network-port Port Director Type State Networks ---- -------- ---- ----- -------- 3:2 ovcasw15r1 sanFc8GbPort down None 3:1 ovcasw15r1 sanFc8GbPort down None 4:1 ovcasw15r1 nwEthernet10GbPort up mgmt_public_eth, vm_public_vlan 4:4 ovcasw15r1 nwEthernet10GbPort down None 4:3 ovcasw15r1 nwEthernet10GbPort down None 4:2 ovcasw15r1 nwEthernet10GbPort down None 5:1 ovcasw15r1 nwEthernet10GbPort up mgmt_public_eth, vm_public_vlan 5:4 ovcasw15r1 nwEthernet10GbPort down None 5:3 ovcasw15r1 nwEthernet10GbPort down None 5:2 ovcasw15r1 nwEthernet10GbPort down None 10:4 ovcasw15r1 nwEthernet10GbPort down None 10:3 ovcasw15r1 nwEthernet10GbPort down None 10:2 ovcasw15r1 nwEthernet10GbPort down None 10:1 ovcasw15r1 nwEthernet10GbPort down None 11:4 ovcasw15r1 nwEthernet10GbPort down None 11:3 ovcasw15r1 nwEthernet10GbPort down None 11:2 ovcasw15r1 nwEthernet10GbPort down None 11:1 ovcasw15r1 nwEthernet10GbPort down None 12:2 ovcasw15r1 sanFc8GbPort down None 12:1 ovcasw15r1 sanFc8GbPort down None 3:2 ovcasw22r1 sanFc8GbPort down None 3:1 ovcasw22r1 sanFc8GbPort down None 4:1 ovcasw22r1 nwEthernet10GbPort up mgmt_public_eth, vm_public_vlan 4:4 ovcasw22r1 nwEthernet10GbPort down None 4:3 ovcasw22r1 nwEthernet10GbPort down None 4:2 ovcasw22r1 nwEthernet10GbPort down None 5:1 ovcasw22r1 nwEthernet10GbPort up mgmt_public_eth, vm_public_vlan 5:4 ovcasw22r1 nwEthernet10GbPort down None 5:3 ovcasw22r1 nwEthernet10GbPort down None 5:2 ovcasw22r1 nwEthernet10GbPort down None 10:4 ovcasw22r1 nwEthernet10GbPort down None 10:3 ovcasw22r1 nwEthernet10GbPort down None 10:2 ovcasw22r1 nwEthernet10GbPort up None 10:1 ovcasw22r1 nwEthernet10GbPort down None 11:4 ovcasw22r1 nwEthernet10GbPort up None 11:3 ovcasw22r1 nwEthernet10GbPort down None 11:2 ovcasw22r1 nwEthernet10GbPort down None 11:1 ovcasw22r1 nwEthernet10GbPort down None 12:2 ovcasw22r1 sanFc8GbPort down None 12:1 ovcasw22r1 sanFc8GbPort down None ----------------- 40 rows displayed Status: Success
Example 3.26 List the I/O Modules installed in the Fabric Interconnects
PCA> list network-card Slot Director Type State Number_Of_Ports ---- -------- ---- ----- --------------- 4 ovcasw22r1 nwEthernet4Port10GbCardEthIb up 4 10 ovcasw22r1 nwEthernet4Port10GbCardEthIb up 4 3 ovcasw22r1 sanFc2Port8GbLrCardEthIb up 2 12 ovcasw22r1 sanFc2Port8GbLrCardEthIb up 2 5 ovcasw22r1 nwEthernet4Port10GbCardEthIb up 4 11 ovcasw22r1 nwEthernet4Port10GbCardEthIb up 4 12 ovcasw15r1 sanFc2Port8GbLrCardEthIb up 2 11 ovcasw15r1 nwEthernet4Port10GbCardEthIb up 4 5 ovcasw15r1 nwEthernet4Port10GbCardEthIb up 4 10 ovcasw15r1 nwEthernet4Port10GbCardEthIb up 4 3 ovcasw15r1 sanFc2Port8GbLrCardEthIb up 2 4 ovcasw15r1 nwEthernet4Port10GbCardEthIb up 4 ----------------- 12 rows displayed Status: Success
Example 3.27 List ports on each Oracle Switch ES1-24 using a Filter
Note that the CLI uses the internal alias for an Oracle Switch ES1-24,
referencing an 'opus' switch or port. In this example the
command displays all internal Ethernet connections to the Net
Mgt port on the destination component. A wildcard is used in
the --filter
option.
PCA> list opus-port --filter-column=Dest_Port --filter=*Mgt Dest Dest_Port Hostname Key OPUS RACK RU Src_Port Type ---- --------- -------- --- ---- ---- -- -------- ---- 22 Net Mgt ovcasw22r1 OPUS-1-9 OPUS-1 1 22 9 switch 19 Net Mgt ovcasw19r1 OPUS-1-10 OPUS-1 1 19 10 switch PDU-A Net Mgt ovcapoPDU-Ar1 OPUS-1-20 OPUS-1 1 0 20 power 15 Net Mgt ovcasw15r1 OPUS-2-9 OPUS-2 1 15 9 switch 20 Net Mgt ovcasw20r1 OPUS-2-10 OPUS-2 1 20 10 switch PDU-B Net Mgt ovcapoPDU-Br1 OPUS-2-20 OPUS-2 1 0 20 power 16 Net Mgt ovcasw16r2 OPUS-3-10 OPUS-3 2 16 10 switch PDU-A Net Mgt ovcapoPDU-Ar2 OPUS-3-20 OPUS-3 2 0 20 power 20 Net Mgt ovcasw20r2 OPUS-4-10 OPUS-4 2 20 10 switch PDU-B Net Mgt ovcapoPDU-Br2 OPUS-4-20 OPUS-4 2 0 20 power 16 Net Mgt ovcasw16r3 OPUS-5-10 OPUS-5 3 16 10 switch PDU-A Net Mgt ovcapoPDU-Ar3 OPUS-5-20 OPUS-5 3 0 20 power 20 Net Mgt ovcasw20r3 OPUS-6-10 OPUS-6 3 20 10 switch PDU-B Net Mgt ovcapoPDU-Br3 OPUS-6-20 OPUS-6 3 0 20 power ----------------- 14 rows displayed Status: Success
Example 3.28 List All Tasks
PCA> list task Task_ID Status Progress Start_Time Task_Name ------- ------ -------- ---------- --------- 341e7bc74f339c SUCCESS 100 06-27-2016 09:59:36 backup 341e73748f5182 SUCCESS 100 06-27-2016 09:00:01 backup 341e0edfa4891e SUCCESS 100 06-26-2016 21:00:01 backup 341daa4a2d3624 SUCCESS 100 06-26-2016 09:00:01 backup 341d45b5424c16 SUCCESS 100 06-25-2016 21:00:01 backup 341ce11fc6c39c SUCCESS 100 06-25-2016 09:00:01 update_download_image 341c7c8afcc86a SUCCESS 100 06-24-2016 21:00:02 backup ---------------- 7 rows displayed Status: Success
Example 3.29 List Storage Networks for External Fibre Channel Storage
PCA> list storage-network Network_Name Description ------------ ----------- Cloud_D Default Storage Cloud ru15 port2 - Do not delete or modify Cloud_A Default Storage Cloud ru22 port1 - Do not delete or modify Cloud_C Default Storage Cloud ru15 port1 - Do not delete or modify Cloud_B Default Storage Cloud ru22 port2 - Do not delete or modify ---------------- 4 rows displayed Status: Success
Example 3.30 List WWPNs To Configure External Fibre Channel Storage
PCA> list wwpn-info WWPN vHBA Cloud_Name Server Type Alias ---- ---- ---------- ------ ---- ----- 50:01:39:70:00:69:F1:06 vhba01 Cloud_A ovcacn08r1 CN ovcacn08r1-Cloud_A 50:01:39:70:00:69:F1:04 vhba01 Cloud_A ovcacn09r1 CN ovcacn09r1-Cloud_A 50:01:39:70:00:69:F1:08 vhba01 Cloud_A ovcacn10r1 CN ovcacn10r1-Cloud_A 50:01:39:70:00:69:F1:0C vhba01 Cloud_A ovcacn32r1 CN ovcacn32r1-Cloud_A 50:01:39:70:00:69:F1:0A vhba01 Cloud_A ovcacn07r1 CN ovcacn07r1-Cloud_A 50:01:39:70:00:69:F1:0E vhba01 Cloud_A ovcacn31r1 CN ovcacn31r1-Cloud_A 50:01:39:70:00:69:F1:07 vhba02 Cloud_B ovcacn08r1 CN ovcacn08r1-Cloud_B 50:01:39:70:00:69:F1:05 vhba02 Cloud_B ovcacn09r1 CN ovcacn09r1-Cloud_B 50:01:39:70:00:69:F1:09 vhba02 Cloud_B ovcacn10r1 CN ovcacn10r1-Cloud_B 50:01:39:70:00:69:F1:0B vhba02 Cloud_B ovcacn07r1 CN ovcacn07r1-Cloud_B 50:01:39:70:00:69:F1:0F vhba02 Cloud_B ovcacn31r1 CN ovcacn31r1-Cloud_B 50:01:39:70:00:69:F1:0D vhba02 Cloud_B ovcacn32r1 CN ovcacn32r1-Cloud_B 50:01:39:70:00:6A:11:0E vhba03 Cloud_C ovcacn31r1 CN ovcacn31r1-Cloud_C 50:01:39:70:00:6A:11:0A vhba03 Cloud_C ovcacn07r1 CN ovcacn07r1-Cloud_C 50:01:39:70:00:6A:11:0C vhba03 Cloud_C ovcacn32r1 CN ovcacn32r1-Cloud_C 50:01:39:70:00:6A:11:08 vhba03 Cloud_C ovcacn10r1 CN ovcacn10r1-Cloud_C 50:01:39:70:00:6A:11:04 vhba03 Cloud_C ovcacn09r1 CN ovcacn09r1-Cloud_C 50:01:39:70:00:6A:11:06 vhba03 Cloud_C ovcacn08r1 CN ovcacn08r1-Cloud_C 50:01:39:70:00:6A:11:0D vhba04 Cloud_D ovcacn32r1 CN ovcacn32r1-Cloud_D 50:01:39:70:00:6A:11:0F vhba04 Cloud_D ovcacn31r1 CN ovcacn31r1-Cloud_D 50:01:39:70:00:6A:11:0B vhba04 Cloud_D ovcacn07r1 CN ovcacn07r1-Cloud_D 50:01:39:70:00:6A:11:09 vhba04 Cloud_D ovcacn10r1 CN ovcacn10r1-Cloud_D 50:01:39:70:00:6A:11:05 vhba04 Cloud_D ovcacn09r1 CN ovcacn09r1-Cloud_D 50:01:39:70:00:6A:11:07 vhba04 Cloud_D ovcacn08r1 CN ovcacn08r1-Cloud_D ----------------- 24 rows displayed Status: Success
Example 3.31 List All Configuration Errors
PCA> list config-error ID Module Host Timestamp -- ------ ---- --------- 87 Management node password 192.168.4.4 Thu Aug 21 02:45:42 2015 84 MySQL management password 192.168.4.216 Thu Aug 21 02:44:54 2015 53 Compute node vHBA 192.168.4.7 Thu Aug 21 01:29:18 2015 ---------------- 3 rows displayed Status: Success
Disconnects a server node from a network.
Syntax
remove network
network-name
node
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where network-name
is the name of the network
from which you wish to disconnect one or more servers, and
node
is the name of the server node that should
be disconnected from the selected network.
Description
Use the remove network command to disconnect
server nodes from a custom network you created. In case you want
to delete a custom network from your environment, you must first
disconnect all the servers from that network. Then use the
delete network command to delete the custom
network configuration. This is a destructive operation and you
are prompted to confirm whether or not you wish to continue,
unless you use the --confirm
flag to override
the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.32 Disconnecting a Compute Node from a Custom Network
PCA> remove networkMyNetwork
ovcacn09r1
************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
Removes a custom network from a tenant group.
Syntax
remove network-from-tenant-group
network-name
tenant-group-name
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where network-name
is the name of a custom
network associated with a tenant group, and
tenant-group-name
is the name of the tenant
group you wish to remove the custom network from.
Description
Use the remove network-from-tenant-group command to break the association between a custom network and a tenant group. The custom network is unconfigured from all tenant group member servers.
This is a destructive operation and you are prompted to confirm
whether or not you wish to continue, unless you use the
--confirm
flag to override the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.33 Removing a Custom Network from a Tenant Group
PCA> remove network-from-tenant-groupmyPublicNetwork
myTenantGroup
************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
Removes a server from an existing tenant group.
Syntax
remove server
node
tenant-group-name
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where tenant-group-name
is the name of the
tenant group you wish to remove one or more servers from, and
node
is the name of the server node that should
be removed from the selected tenant group.
Description
Use the remove server command to remove the required server nodes from their tenant group. Use Oracle VM Manager to prepare the compute nodes first: make sure that virtual machines have been migrated away from the compute node, and that no storage repositories are presented. Custom networks associated with the tenant group are removed from the server, not from the tenant group.
This is a destructive operation and you are prompted to confirm
whether or not you wish to continue, unless you use the
--confirm
flag to override the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.34 Removing a Compute Node from a Tenant Group
PCA> remove server ovcacn09r1 myTenantGroup
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: Success
The reprovision command can be used to trigger reprovisioning for a specified compute node within the Oracle Private Cloud Appliance.
Reprovisioning restores a compute node to a clean state. If a compute node was previously added to the Oracle VM environment and has active connections to storage repositories other than those on the internal ZFS storage, the external storage connections need to be configured again after reprovisioning.
Syntax
reprovision
{
compute-node
}
node
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
] [
--force
] [
--save-local-repo
]
where node
is the compute node name for the
compute node that should be reprovisioned.
Description
Use the reprovision command to reprovision a specified compute node. The provisioning process is described in more detail in Section 1.4, “Provisioning and Orchestration”.
The reprovision command triggers a task that is responsible for handling the reprovisioning process and exits immediately with status 'Success' if the task has been successfully generated. This does not mean that the reprovisioning process itself has completed successfully. To monitor the status of the reprovisioning task, you can use the list compute-node command to check the provisioning state of the servers. You can also monitor the log file for information relating to provisioning tasks. The location of the log file can be obtained by checking the Log_File parameter when you run the show system-properties command. See Example 3.40, “Show System Properties” for more information.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| The command target to perform the reprovision operation against. |
| Skip the HMP step in the provisioning process in order to save the local storage repository. |
| Return the output of the command in JSON format. |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| Force the command to be executed even if the target is in an invalid state. This option is not risk-free and should only be used as a last resort. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.35 Reprovisioning a Compute Node
Do not force reprovisioning on a compute node with running virtual machines because they will be left in an indeterminate state.
PCA> reprovision compute-node ovcacn11r1 Status: Success
Triggers a configuration task to re-run on the Oracle Private Cloud Appliance.
Syntax
rerun
{
config-task
}
id
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where id
is the identifier for the
configuration task that must be re-run.
Description
Use the rerun command to re-initiate a configuration task that has failed. Use the list config-error command to view the configuration tasks that have failed and the associated identifier that you should use in conjunction with this command. See Example 3.31, “List All Configuration Errors” for more information.
You can use the show task command to view the status of the task after you have triggered it to run. See Example 3.41, “Show Task” for more information.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| The command target to perform the rerun operation against. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Sets the value for a system property on the Oracle Private Cloud Appliance.
Syntax
set system-property
{
ftp_proxy
|
http_proxy
|
https_proxy
|
log_count
|
log_file
|
log_level
|
log_size
|
timezone
}
value
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where value
is the value for the system
property that you are setting.
Description
Use the set system-property command to set the value for a system property on the Oracle Private Cloud Appliance.
The set system-property command only affects the settings for the management node where it is run. If you change a setting on the active management node, using this command, you should connect to the passive management node and run the equivalent command there as well, to keep the two systems synchronized. This is the only exception where it is necessary to run a CLI command on the passive management node.
You can use the show system-properties command to view the values of various system properties at any point. See Example 3.40, “Show System Properties” for more information.
Changes to system-properties usually require that you restart the service for the change to take effect. To do this, you must run service ovca restart in the shell of the active management node after you have set the system property value.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Set the value for the IP address of an FTP Proxy |
| Set the value for the IP address of an HTTP Proxy |
| Set the value for the IP address of an HTTPS Proxy |
| Set the value for the number of log files that should be retained through log rotation |
| Set the value for the location of a particular log file. This property can be defined separately for the following log files: backup, cli, diagnosis, monitor, ovca, snmp, and syncservice. |
| Set the value for the log level output. Accepted log levels are: CRITICAL, DEBUG, ERROR, INFO, NOTSET, VERBOSE, WARN, and WARNING. This property can be defined separately for the following log files: backup, cli, diagnosis, monitor, ovca, snmp, and syncservice. |
| Set the value for the maximum log size before a log is rotated |
| Set the time zone for the location of the Oracle PCA. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.37 Changing the location of the sync service log file
PCA> set system-property log_file syncservice /mnt/filer/logs/syncservice.log Status: Success
Log configuration through the CLI is described in more detail in Section 7.2, “Setting the Oracle Private Cloud Appliance Logging Parameters”.
Example 3.38 Configuring and unconfiguring an HTTP proxy
PCA> set system-property http_proxy http://proxy.example.com:8080 Status: Success PCA> set system-property http_proxy '' Status: Success
Proxy configuration through the CLI is described in more detail in Section 7.1, “Adding Proxy Settings for Oracle Private Cloud Appliance Updates”.
Example 3.39 Configuring the Oracle PCA Time Zone
PCA> set system-property timezone US/Eastern Status: Success
The show command can be used to view information about particular objects such as tasks, rack layout or system properties. Unlike the list command, which applies to a whole target object type, the show command displays information specific to a particular target object. Therefore, it is usually run by specifying the command, the target object type and the object identifier.
Syntax
show
{
cloud-wwpn
|
compute-node
|
network
|
rack-layout
|
server-profile
|
storage-network
|
system-properties
|
task
|
tenant-group
|
version
|
vhba-info
}
object
[
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
Where object
is the identifier for the target
object that you wish to show information for. The following
table provides a mapping of identifiers that should be
substituted for object
, depending on the
command target.
Command Target | Object Identifier |
---|---|
cloud-wwpn | Storage Network/Cloud Name |
compute-node | Compute Node Name |
network | Network Name |
rack-layout | Rack Architecture or Type |
server-profile | Server Name |
storage-network | Storage Network/Cloud Name |
system-properties | (none) |
task | Task ID |
tenant-group | Tenant Group Name |
version | (none) |
vhba-info | Compute Node Name |
Note that you can use tab completion to help you correctly
specify the object
for the different command
targets. You do not need to specify an object
if the command target is system-properties
or
version
.
Description
Use the show command to view information
specific to a particular target object, identified by specifying
the identifier for the object that you wish to view. The
exception to this is the option to view
system-properties
, for which no identifier is
required.
Frequently, the show command may display information that is not available using the list command in conjunction with its filtering capabilities.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| The command target to show information for. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.40 Show System Properties
This command only displays the system properties for the management node where it is run. If the system properties have become unsynchronized across the two management nodes, the information reflected by this command may not apply to both systems. You can run this command on either the active or passive management node if you need to check that the configurations match.
PCA> show system-properties ---------------------------------------- HTTP_Proxy None HTTPS_Proxy None FTP_Proxy None Log_File /var/log/ovca.log Log_Level DEBUG Log_Size (MB) 250 Log_Count 5 Timezone US/Eastern Backup.Log_File /var/log/ovca-backup.log Backup.Log_Level DEBUG Cli.Log_File /var/log/ovca-cli.log Cli.Log_Level DEBUG Sync.Log_File /var/log/ovca-sync.log Sync.Log_Level DEBUG Diagnosis.Log_File /var/log/ovca-diagnosis.log Diagnosis.Log_Level DEBUG Monitor.Log_File /var/log/ovca-monitor.log Monitor.Log_Level DEBUG Snmp.Log_File /nfs/shared_storage/logs/ovca_snmptrapd.log Snmp.Log_Level DEBUG ---------------------------------------- Status: Success
Example 3.41 Show Task
PCA> show task 341e7bc74f339c ---------------------------------------- Task_Name backup Status RUNNING Progress 70 Start_Time 06-27-2016 09:59:36 End_Time None Pid 1503341 Result None ---------------------------------------- Status: Success
Example 3.42 Show Rack Layout
PCA> show rack-layout x5-2_base RU Name Role Type Sub_Type Units -- ---- ---- ---- -------- ----- 42 ovcacn42r1 compute compute [42] 41 ovcacn41r1 compute compute [41] 40 ovcacn40r1 compute compute [40] 39 ovcacn39r1 compute compute [39] 38 ovcacn38r1 compute compute [38] 37 ovcacn37r1 compute compute [37] 36 ovcacn36r1 compute compute [36] 35 ovcacn35r1 compute compute [35] 34 ovcacn34r1 compute compute [34] 33 ovcacn33r1 compute compute [33] 32 ovcacn32r1 compute compute [32] 31 ovcacn31r1 compute compute [31] 30 ovcacn30r1 compute compute [30] 29 ovcacn29r1 compute compute [29] 28 ovcacn28r1 compute compute [28] 27 ovcacn27r1 compute compute [27] 26 ovcacn26r1 compute compute [26] 25 ovcasw22r1 infrastructure switch ovn-switch2 [25, 24, 23, 22] 24 ovcasw22r1 infrastructure switch ovn-switch2 [25, 24, 23, 22] 23 ovcasw22r1 infrastructure switch ovn-switch2 [25, 24, 23, 22] 22 ovcasw22r1 infrastructure switch ovn-switch2 [25, 24, 23, 22] 21 ovcasw21br1 infrastructure switch opus-switch2 [21] 21 ovcasw21ar1 infrastructure switch opus-switch1 [21] 20 ovcasw20r1 infrastructure switch ib-switch2 [20] 19 ovcasw19r1 infrastructure switch ib-switch1 [19] 18 ovcasw15r1 infrastructure switch ovn-switch1 [18, 17, 16, 15] 17 ovcasw15r1 infrastructure switch ovn-switch1 [18, 17, 16, 15] 16 ovcasw15r1 infrastructure switch ovn-switch1 [18, 17, 16, 15] 15 ovcasw15r1 infrastructure switch ovn-switch1 [18, 17, 16, 15] 14 ovcacn14r1 compute compute [14] 13 ovcacn13r1 compute compute [13] 12 ovcacn12r1 compute compute [12] 11 ovcacn11r1 compute compute [11] 10 ovcacn10r1 compute compute [10] 9 ovcacn09r1 compute compute [9] 8 ovcacn08r1 compute compute [8] 7 ovcacn07r1 compute compute [7] 6 ovcamn06r1 infrastructure management management2 [6] 5 ovcamn05r1 infrastructure management management1 [5] 4 N / A infrastructure storage disk-shelf [4, 3] 3 N / A infrastructure storage disk-shelf [4, 3] 2 ovcasn02r1 infrastructure storage zfs-head2 [2] 1 ovcasn01r1 infrastructure storage zfs-head1 [1] 0 ovcapduBr1 infrastructure pdu pdu2 [0] 0 ovcapduAr1 infrastructure pdu pdu1 [0] ----------------- 45 rows displayed Status: Success
Example 3.43 Show the Ports and VNICs in the mgmt_public_eth Network
PCA> show network mgmt_public_eth ---------------------------------------- Cloud_Name mgmt_public_eth Trunkmode True Description 2015-07-12 02:09:42 Ports ovcasw22r1:5:1, ovcasw22r1:4:1, ovcasw15r1:5:1, ovcasw15r1:4:1 Vnics ovcacn27r1-eth5, ovcacn13r1-eth5, ovcacn14r1-eth5, ovcacn09r1-eth5, ovcacn36r1-eth5, ovcamn06r1-eth5, ovcacn29r1-eth5, ovcacn07r1-eth5, ovcacn12r1-eth5, ovcacn30r1-eth5, ovcacn42r1-eth5, ovcacn40r1-eth5, ovcacn10r1-eth5, ovcacn28r1-eth5, ovcacn41r1-eth5, ovcamn05r1-eth5, ovcacn38r1-eth5, ovcacn34r1-eth5, ovcacn37r1-eth5, ovcacn11r1-eth5, ovcacn26r1-eth5, ovcacn39r1-eth5, ovcacn35r1-eth5 Status None Network_Type external_network Compute_Nodes ovcacn27r1, ovcacn13r1, ovcacn14r1, ovcacn09r1, ovcacn36r1, ovcacn06r1, ovcacn29r1, ovcacn07r1, ovcacn12r1, ovcacn30r1, ovcacn42r1, ovcacn40r1, ovcacn10r1, ovcacn28r1, ovcacn05r1, ovcacn34r1, ovcacn11r1, ovcacn26r1, ovcacn35r1 Prefix 192.168.100 Netmask None Route Destination None Route Gateway None ---------------------------------------- Status: Success
Example 3.44 Show Details of a Storage Network
PCA> show storage-network Cloud_A ---------------------------------------- Cloud_Name Cloud_A Description Default Storage Cloud ru22 port1 - Do not delete or modify Ports ovcasw22r1:12:1, ovcasw22r1:3:1 vHBAs ovcacn11r1-vhba01, ovcacn29r1-vhba01, ovcacn12r1-vhba01, ovcacn09r1-vhba01, ovcacn14r1-vhba01, ovcacn28r1-vhba01, ovcacn08r1-vhba01, ovcacn30r1-vhba01, ovcacn26r1-vhba01, ovcacn13r1-vhba01, ovcacn27r1-vhba01, ovcacn31r1-vhba01, ovcacn10r1-vhba01, ovcamn06r1-vhba01, ovcamn05r1-vhba01 ---------------------------------------- Status: Success
Example 3.45 Show Details of a Tenant Group
PCA> show tenant-group myTenantGroup
----------------------------------------
Name myTenantGroup
Default False
Tenant Group ID 0004fb0000020000155c15e268857a78
Servers ['ovcacn09r1', 'ovcacn10r1']
State ready
Tenant Group VIP 192.168.140.131
Networks ['myPublicNetwork']
Pool Filesystem ID 3600144f0d29d4c86000057162ecc0001
----------------------------------------
Status: Success
Example 3.46 Show Details of a Custom Network
PCA> show network myHostNetwork
----------------------------------------
Network_Name myHostNetwork
Trunkmode True
Description User defined network
Ports ['11:4']
vNICs ovcacn02r2-eth8, ovcacn01r2-eth8, ovcacn42r1-eth8
Status ready
Network_Type host_network
Compute_Nodes ovcacn42r1, ovcacn01r2, ovcacn02r2
Prefix 10.10.10
Netmask 255.255.255.0
Route Destination 10.10.20.0/24
Route Gateway 10.10.10.250
----------------------------------------
Status: Success
Example 3.47 Show the WWPNs for a Storage Network
PCA> show cloud-wwpn Cloud_A ---------------------------------------- Cloud_Name Cloud_A WWPN_List 50:01:39:70:00:58:91:1C, 50:01:39:70:00:58:91:1A, 50:01:39:70:00:58:91:18, 50:01:39:70:00:58:91:16, 50:01:39:70:00:58:91:14, 50:01:39:70:00:58:91:12, 50:01:39:70:00:58:91:10, 50:01:39:70:00:58:91:0E, 50:01:39:70:00:58:91:0C, 50:01:39:70:00:58:91:0A, 50:01:39:70:00:58:91:08, 50:01:39:70:00:58:91:06, 50:01:39:70:00:58:91:04, 50:01:39:70:00:58:91:02, 50:01:39:70:00:58:91:00 ---------------------------------------- Status: Success
Example 3.48 Show the vHBA configuration for a Compute Node
PCA> show vhba-info ovcacn10r1 vHBA_Name Cloud WWNN WWPN ------------- ----------- ------------- ------------- vhba03 Cloud_C 50:01:39:71:00:58:B1:04 50:01:39:70:00:58:B1:04 vhba02 Cloud_B 50:01:39:71:00:58:91:05 50:01:39:70:00:58:91:05 vhba01 Cloud_A 50:01:39:71:00:58:91:04 50:01:39:70:00:58:91:04 vhba04 Cloud_D 50:01:39:71:00:58:B1:05 50:01:39:70:00:58:B1:05 ---------------- 4 rows displayed Status: Success
Example 3.49 Show Oracle PCA Version Information
PCA> show version ---------------------------------------- Version 2.2.1 Build 384 Date 2016-04-19 ---------------------------------------- Status: Success
Starts up a rack component.
Feature disabled in this release.
Syntax
start
{
compute-node
CN
|
management-node
MN
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where CN
refers to the name of the compute node
and MN
refers to the name of the management
node to be started.
Description
Use the start command to boot a compute node or management node. You must provide the host name of the server you wish to start.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Start either a compute node or a management node. Replace CN or MN respectively with the host name of the server to be started. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Shuts down a rack component or aborts a running task.
Stopping a rack component is disabled in this release.
Syntax
stop
{
compute-node
CN
|
management-node
MN
|
task
id
|
update-task
id
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where CN
or MN
refers to the
name of the server to be shut down, and id
refers to the identifier of the task to be aborted.
Description
Use the stop command to shut down a compute
node or management node or to abort a running task. Depending on
the command target you must provide either the host name of the
server you wish to shut down, or the unique identifier of the
task you wish to abort. This is a destructive operation and you
are prompted to confirm whether or not you wish to continue,
unless you use the --confirm
flag to override
the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Shut down either a compute node or a management node. Replace CN or MN respectively with the host name of the server to be shut down. |
| Aborts a running task.
Use the Caution Stopping an update task is a risky operation and should be used with extreme caution. |
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.51 Aborting a Task
PCA> stop task 341d45b5424c16 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
Updates the Oracle PCA software stack by downloading and installing a new ISO image.
Syntax
update appliance
{
get_image
url
|
install_image
} [
--confirm
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where url
is the download location for the
zipped ISO file containing the software update.
Description
Use the update appliance command to first
download a new version of the Oracle PCA software stack, and
then launch the software update process. This is a destructive
operation and you are prompted to confirm whether or not you
wish to continue, unless you use the --confirm
flag to override the prompt.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
| Start the task to download the zipped ISO file containing the software update from the specified url. |
| Start the task to update the appliance software stack with the previously downloaded image file. |
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.52 Downloading an Oracle PCA Software Update
PCA> update appliance get_image http://myserver.org/images/ovca-2.1.1-b999.iso.zip ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y The update job has been submitted. Use "show task <task id>" to monitor the progress. Task_ID Status Progress Start_Time Task_Name ------- ------ -------- ---------- --------- 333dcc8b617f74 RUNNING None 09-15-2015 11:40:53 update_download_image --------------- 1 row displayed Status: Success
Modifies the password for one or more components within the Oracle Private Cloud Appliance.
Syntax
update password
{
mgmt-root
|
mysql-ovs
|
nm-ilom-admin
|
nm-ilom-operator
|
nm-root
|
opus-root
|
ovm-admin
|
spCn-root
|
spMn-root
|
spZfs-root
|
system-root
|
wls-weblogic
|
xsigo-admin
|
xsigo-recovery
|
xsigo-root
|
zfs-root
} [
PCA-password
target-password
] [
--confirm
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where PCA-password
is the current password of
the Oracle PCA admin user, and
target-password
is the new password to be
applied to the target rack component.
Description
Use the update password command to modify the
password for one or more components within the Oracle Private Cloud Appliance.
This is a destructive operation and you are prompted to confirm
whether or not you wish to continue, unless you use the
--confirm
flag to override the prompt.
Optionally you provide the current Oracle PCA password and the new target component password with the command. If not, you are prompted for the current password of the Oracle PCA admin user and for the new password that should be applied to the target.
Options
The following table shows the available options for this command.
Option | Description |
---|---|
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the
|
|
Sets a new password for the
|
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the
|
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
|
Sets a new password for the |
| Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
| Return the output of the command in JSON format |
| Return the output of the command one screen at a time for easy viewing, as with the less command on the Linux command line. This option allows both forward and backward navigation through the command output. |
| Return the output of the command one screen at a time for easy viewing, as with the more command on the Linux command line. This option allows forward navigation only. |
| When returning the output of the command, also write it to the specified output file. |
Examples
Example 3.53 Changing the Oracle VM Manager Administrator Password
PCA> update password ovm-admin ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Current PCA Password: New ovm-admin Password: Confirm New ovm-admin Password: Status: Success