- 3.2.1 add compute-node
- 3.2.2 add network
- 3.2.3 add network-to-tenant-group
- 3.2.4 backup
- 3.2.5 configure
- 3.2.6 create lock
- 3.2.7 create network
- 3.2.8 create tenant-group
- 3.2.9 create uplink-port-group
- 3.2.10 delete config-error
- 3.2.11 delete lock
- 3.2.12 delete network
- 3.2.13 delete task
- 3.2.14 delete tenant-group
- 3.2.15 delete uplink-port-group
- 3.2.16 deprovision compute-node
- 3.2.17 diagnose
- 3.2.18 get log
- 3.2.19 list
- 3.2.20 remove compute-node
- 3.2.21 remove network
- 3.2.22 remove network-from-tenant-group
- 3.2.23 reprovision
- 3.2.24 rerun
- 3.2.25 set system-property
- 3.2.26 show
- 3.2.27 start
- 3.2.28 stop
- 3.2.29 update appliance
- 3.2.30 update password
This section describes all of the documented commands available via the CLI.
Adds a compute node to an existing tenant group. To create a new tenant group, see Section 3.2.8, “create tenant-group”.
Syntax
add compute-node
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 compute nodes to, and
node is the name of the compute node that
should be added to the selected tenant group.
Description
Use the add compute-node 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.3 Adding a Compute Node to a Tenant Group
PCA> add compute-node ovcacn09r1 myTenantGroup
Status: SuccessConnects 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.4 Connecting a Compute Node to a Custom Network
PCA> add networkMyNetworkovcacn09r1Status: 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.
This command involves verification steps that are performed in the background. Consequently, even though output is returned and you regain control of the CLI, certain operations continue to run for some time.
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 Associating a Custom Network with a Tenant Group
PCA> add network-to-tenant-groupmyPublicNetworkmyTenantGroupValidating servers in the tenant group... This may take some time. The job for sync all nodes in tenant group with the new networkmyPublicNetworkhas been submitted. Please look into "/var/log/ovca.log" and "/var/log/ovca-sync.log" to monitor the progress. 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 Private Cloud Appliance 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 and name, 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.42, “Show Task” for more information.
Options
There are no further options for this command.
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 ------- ------ -------- ---------- --------- 3769a13df448a2 RUNNING None 06-05-2019 09:21:36 backup --------------- 1 row 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
|
cn_upgrade
|
database
|
install
|
manufacturing
|
mn_upgrade
|
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. |
| Prevent all compute node upgrade operations. |
| 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 all management node upgrade operations. |
| 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.7, “Network Customization” for detailed information.
Syntax
create network
network-name
{
rack_internal_network
|
external_network port-group
|
host_network port-group 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 spine switch ports used for public connectivity must also be
specified as port-group. For this purpose, you
must first create an uplink port group. See
Section 3.2.9, “create uplink-port-group”
for more information.
If the network type is host_network, then
additional arguments are expected. The subnet arguments 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 spine switch as well. The ports must belong to an uplink port group, and you provide the port group name as an argument in this command. |
| To create a custom host network, you must specify the ports on the spine switch as with an external network. The ports must belong to an uplink port group, and you provide the port group name as an argument in this command. 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.8 Creating an Internal Custom Network
PCA> create network MyPrivateNetwork rack_internal_network
Status: SuccessExample 3.9 Creating a Custom Network with External Connectivity
PCA> create networkMyPublicNetworkexternal_networkmyUplinkPortGroupStatus: 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.8, “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 compute nodes using the add compute-node 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
Creates a new uplink port group. Uplink port groups define which spine switch ports are used together and in which breakout mode they operate. For detailed information, refer to Appliance Uplink Configuration in the Oracle Private Cloud Appliance Installation Guide.
Syntax
create uplink-port-group
port-group-name
ports
{
10g-4x
|
25g-4x
|
40g
|
100g
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where port-group-name is the name of the uplink
port group, which must be unique. An uplink port group consists
of a list of ports operating in one of the
available breakout modes.
Description
Use the create uplink-port-group command to configure the ports reserved on the spine switches for external connectivity. Port 5 is configured and reserved for the default external network; ports 1-4 can be used for custom external networks. The ports can be used at their full 100Gbit bandwidth, at 40Gbit, or split with a breakout cable into four equal breakout ports: 4x 10Gbit or 4x 25Gbit. The port speed is reflected in the breakout mode of the uplink port group.
Options
The following table shows the available options for this command.
Option | Description |
|---|---|
|
To create an uplink port group, you must specify which
ports on the spine switches belong to the port group.
Ports must always be specified in adjacent pairs. They
are identified by their port number and optionally,
separated by a colon, also their breakout port ID. Put
the port identifiers between quotes as a
space-separated list, for example: |
{
| Set the breakout mode of the uplink port group. When a 4-way breakout cable is used, all four ports must be set to either 10Gbit or 25Gbit. When no breakout cable is used, the port speed for the uplink port group should be either 100Gbit or 40Gbit, depending on connectivity requirements. |
| 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.11 Creating an Uplink Port Group
PCA> create uplink-port-groupmyUplinkPortGroup'3:1 3:2' 10g-4x Status: Success PCA> create uplink-port-groupmyStoragePortGroup'1 2' 40g Status: Success
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.32, “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
|
cn_upgrade
|
database
|
install
|
manufacturing
|
mn_upgrade
|
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.7, “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.21, “remove network”.
Default Oracle Private Cloud Appliance 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: SuccessExample 3.15 Attempting to Delete a Default Network
PCA> delete network default_internal Status: Failure Error Message: Error (NETWORK_003): Exception while deleting network: default_internal. ['INVALID_NAME_002: Invalid Network name: default_internal. 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.8, “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.
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: SuccessDeletes an uplink port group. See Section 3.2.9, “create uplink-port-group” for more information about the use of uplink port groups.
Syntax
delete uplink-port-group
port-group-name
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where port-group-name is the name of the uplink
port group you wish to remove from the environment.
Description
Use the delete uplink-port-group command to remove a previously created uplink port group from your environment. If the uplink port group is used in the configuration of a network, this network must be deleted before the uplink port group can be deleted. Otherwise the delete command will fail.
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.18 Deleting an Uplink Port Group
PCA> delete uplink-port-group myUplinkPortGroup
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: SuccessCleanly removes a previously provisioned compute node's records in the various configuration databases. A provisioning lock must be applied in advance, otherwise the node is reprovisioned shortly after deprovisioning.
Syntax
deprovision compute-node
compute-node-name
[
--confirm
] [
--force
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where compute-node-name is the name of the
compute node you wish to remove from the appliance
configuration.
Description
Use the deprovision compute-node command to take an existing compute node out of the appliance in such a way that it can be repaired or replaced, and subsequently rediscovered as a brand new component. The compute node configuration records are removed cleanly from the system.
For deprovisioning to succeed, the compute node ILOM password must be the default Welcome1. If this is not the case, the operation may result in an error. This also applies to reprovisioning an existing compute node.
By default, the command does not continue if the compute node contains running VMs. The correct workflow is to impose a provisioning lock before deprovisioning a compute node, otherwise it is rediscovered and provisioned again shortly after deprovisioning has completed. When the appliance is ready to resume its normal operations, release the provisioning lock again. For details, see Section 3.2.6, “create lock” and Section 3.2.11, “delete lock”.
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.19 Deprovisioning a Compute Node
deprovision compute-node ovcacn29r1 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Shutting down dhcpd: [ OK ] Starting dhcpd: [ OK ] Shutting down dnsmasq: [ OK ] Starting dnsmasq: [ OK ] Status: Success
Performs various diagnostic checks against the Oracle Private Cloud Appliance for support purposes.
Syntax
diagnose {
ilom
|
software
|
hardware
|
rack-monitor
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
The following table describes each possible target of the diagnose command.
Command Target | Information Displayed |
|---|---|
ilom |
The |
software |
The |
hardware |
The
|
rack-monitor |
The If required, the results can be filtered by component type (cn, ilom, mn, etc.) Use tab completion to see all component types available. |
Description
Use the diagnose command to initiate a diagnostic check of various components that make up Oracle Private Cloud Appliance.
A large part of the diagnostic information is stored in the inventory database and the monitor database. The inventory database is populated from the initial rack installation and keeps a history log of all the rack components. The monitor database stores rack component events detected by the monitor service. Some of the diagnostic commands are used to display the contents of these databases.
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 Running the ILOM Diagnostic
PCA> diagnose ilom
Checking ILOM health............please wait..
IP_Address Status Health_Details
---------- ------ --------------
192.168.4.129 Not Connected None
192.168.4.128 Not Connected None
192.168.4.127 Not Connected None
192.168.4.126 Not Connected None
192.168.4.125 Not Connected None
192.168.4.124 Not Connected None
192.168.4.123 Not Connected None
192.168.4.122 Not Connected None
192.168.4.121 Not Connected None
192.168.4.120 Not Connected None
192.168.4.101 OK None
192.168.4.102 OK None
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 None
192.168.4.106 OK None
192.168.4.109 OK None
192.168.4.108 OK None
192.168.4.112 OK None
192.168.4.113 Not Connected None
192.168.4.110 OK None
192.168.4.111 OK None
192.168.4.116 Not Connected None
192.168.4.117 Not Connected None
192.168.4.114 Not Connected None
192.168.4.115 Not Connected None
192.168.4.118 Not Connected None
192.168.4.119 Not Connected None
-----------------
27 rows displayed
Status: SuccessExample 3.21 Running the Software Diagnostic
PCA> diagnose software PCA Software Acceptance Test runner utility Test - 01 - OpenSSL CVE-2014-0160 Heartbleed bug Acceptance [PASSED] Test - 02 - PCA package Acceptance [PASSED] Test - 03 - Shared Storage Acceptance [PASSED] Test - 04 - PCA services Acceptance [PASSED] Test - 05 - PCA config file Acceptance [PASSED] Test - 06 - Check PCA DBs exist Acceptance [PASSED] Test - 07 - Compute node network interface Acceptance [PASSED] Test - 08 - OVM manager settings Acceptance [PASSED] Test - 09 - Check management nodes running Acceptance [PASSED] Test - 10 - Check OVM manager version Acceptance [PASSED] Test - 11 - OVM server model Acceptance [PASSED] Test - 12 - Repositories defined in OVM manager Acceptance [PASSED] Test - 13 - Management Nodes have IPv6 disabled [PASSED] Test - 14 - Bash Code Injection Vulnerability bug Acceptance [PASSED] Test - 15 - Check Oracle VM 3.4 xen security update Acceptance [PASSED] Test - 16 - Test for ovs-agent service on CNs Acceptance [PASSED] Test - 17 - Test for shares mounted on CNs Acceptance [PASSED] Test - 18 - All compute nodes running Acceptance [PASSED] Test - 19 - PCA version Acceptance [PASSED] Test - 20 - Check support packages in PCA image Acceptance [PASSED] Status: Success
Retrieves the log files from the selected components and saves them to a directory on the rack's shared storage.
Currently the spine or data switch 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 directory on the internal storage appliance in a location that both management nodes can access. 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.22 Collecting the Log Files from the Spine Switch
Note that the CLI uses 'data_switch' as the internal alias for a spine Cisco Nexus 9336C-FX2 Switch.
PCA> get log data_switch Log files copied to: /nfs/shared_storage/incoming 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
|
mgmt-switch-port
|
network
|
network-port
|
network-switch
|
task
|
tenant-group
|
update-task
|
uplink-port
|
uplink-port-group
} [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
] [
[
--sorted-by SORTEDBY
|
--sorted-order SORTEDORDER
]
] [
[
--filter-column FILTERCOLUMN
|
--filter FILTER
]
]
where SORTEDBYSORTEDORDERASC for an ascending sort, or
DES for a descending sort. See
Section 3.1.3.2, “Sorting” for more
information.
where FILTERCOLUMNFILTER
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. |
mgmt-switch-port | Displays connection information about every port in the Oracle Private Cloud Appliance environment belonging to the internal administration or management network. The ports listed can belong to a switch, a server node or any other connected rack component type. |
network | Displays all networks configured in the environment. |
network-port | Displays information about all ports reserved on the spine switches for external networking. |
network-switch | Displays basic information about all switches installed in the Oracle Private Cloud Appliance environment. |
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. |
uplink-port | Displays information about spine switch port configurations for external networking. |
uplink-port-group | Displays information about all uplink port groups configured for external networking. |
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 Private Cloud Appliance. 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
|
Examples
Example 3.23 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:e9:1f:c9 running None ovcamn06r1 192.168.4.4 RUNNING 00:10:e0:e7:26:ad running Yes ---------------- 2 rows displayed Status: Success
Example 3.24 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.25 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.26 List Appliance Networks
PCA> list network Network_Name Default Type Trunkmode Description ------------ ------- ---- --------- ----------- custom_internal False rack_internal_network None None default_internal True rack_internal_network None None storage_net False host_network None None default_external True external_network None None ---------------- 4 rows displayed Status: Success
Example 3.27 List the Network Ports Configured on the Spine Cisco Nexus 9336C-FX2 Switches
PCA> list network-port Port Switch Type State Networks ---- ------ ---- ----- -------- 1 ovcasw22r1 40G up storage_net 2 ovcasw22r1 40G up storage_net 3 ovcasw22r1 auto-speed down None 4 ovcasw22r1 auto-speed down None 5:1 ovcasw22r1 10G up default_external 5:2 ovcasw22r1 10G down default_external 5:3 ovcasw22r1 10G down None 5:4 ovcasw22r1 10G down None 1 ovcasw23r1 40G up storage_net 2 ovcasw23r1 40G up storage_net 3 ovcasw23r1 auto-speed down None 4 ovcasw23r1 auto-speed down None 5:1 ovcasw23r1 10G up default_external 5:2 ovcasw23r1 10G down default_external 5:3 ovcasw23r1 10G down None 5:4 ovcasw23r1 10G down None ----------------- 16 rows displayed Status: Success
Example 3.28 List Ports on the Management Cisco Nexus 9348GC-FXP Switch Using a Filter
Note that the CLI uses the internal alias
mgmt-switch-port. In this example the
command displays all internal Ethernet connections from
compute nodes to the Cisco Nexus 9348GC-FXP Switch. A wildcard is used in
the --filter option.
PCA> list mgmt-switch-port --filter-column=Hostname --filter=*cn*r1 Dest Dest_Port Hostname Key MGMTSWITCH RACK RU Src_Port Type ---- --------- -------- --- ---------- ---- -- -------- ---- 07 Net-0 ovcacn07r1 CISCO-1-5 CISCO-1 1 7 5 compute 08 Net-0 ovcacn08r1 CISCO-1-6 CISCO-1 1 8 6 compute 09 Net-0 ovcacn09r1 CISCO-1-7 CISCO-1 1 9 7 compute 10 Net-0 ovcacn10r1 CISCO-1-8 CISCO-1 1 10 8 compute 11 Net-0 ovcacn11r1 CISCO-1-9 CISCO-1 1 11 9 compute 12 Net-0 ovcacn12r1 CISCO-1-10 CISCO-1 1 12 10 compute 13 Net-0 ovcacn13r1 CISCO-1-11 CISCO-1 1 13 11 compute 14 Net-0 ovcacn14r1 CISCO-1-12 CISCO-1 1 14 12 compute 34 Net-0 ovcacn34r1 CISCO-1-15 CISCO-1 1 34 15 compute 35 Net-0 ovcacn35r1 CISCO-1-16 CISCO-1 1 35 16 compute 36 Net-0 ovcacn36r1 CISCO-1-17 CISCO-1 1 36 17 compute 37 Net-0 ovcacn37r1 CISCO-1-18 CISCO-1 1 37 18 compute 38 Net-0 ovcacn38r1 CISCO-1-19 CISCO-1 1 38 19 compute 39 Net-0 ovcacn39r1 CISCO-1-20 CISCO-1 1 39 20 compute 40 Net-0 ovcacn40r1 CISCO-1-21 CISCO-1 1 40 21 compute 41 Net-0 ovcacn41r1 CISCO-1-22 CISCO-1 1 41 22 compute 42 Net-0 ovcacn42r1 CISCO-1-23 CISCO-1 1 42 23 compute 26 Net-0 ovcacn26r1 CISCO-1-35 CISCO-1 1 26 35 compute 27 Net-0 ovcacn27r1 CISCO-1-36 CISCO-1 1 27 36 compute 28 Net-0 ovcacn28r1 CISCO-1-37 CISCO-1 1 28 37 compute 29 Net-0 ovcacn29r1 CISCO-1-38 CISCO-1 1 29 38 compute 30 Net-0 ovcacn30r1 CISCO-1-39 CISCO-1 1 30 39 compute 31 Net-0 ovcacn31r1 CISCO-1-40 CISCO-1 1 31 40 compute 32 Net-0 ovcacn32r1 CISCO-1-41 CISCO-1 1 32 41 compute 33 Net-0 ovcacn33r1 CISCO-1-42 CISCO-1 1 33 42 compute ----------------- 25 rows displayed Status: Success
Example 3.29 List All Tasks
PCA> list task Task_ID Status Progress Start_Time Task_Name ------- ------ -------- ---------- --------- 376a676449206a SUCCESS 100 06-06-2019 09:00:01 backup 376ce11fc6c39c SUCCESS 100 06-06-2019 04:23:41 update_download_image 376a02cf798f68 SUCCESS 100 06-05-2019 21:00:02 backup 376c7c8afcc86a SUCCESS 100 06-05-2019 09:00:01 backup ---------------- 4 rows displayed Status: Success
Example 3.30 List Uplink Ports to Configure External Networking
PCA> list uplink-port Interface Name Switch Status Admin_Status PortChannel Speed -------------- ------ ------ ------------ ----------- ----- Ethernet1/1 ovcasw22r1 up up 111 40G Ethernet1/1 ovcasw23r1 up up 111 40G Ethernet1/2 ovcasw22r1 up up 111 40G Ethernet1/2 ovcasw23r1 up up 111 40G Ethernet1/3 ovcasw22r1 down down None auto Ethernet1/3 ovcasw23r1 down down None auto Ethernet1/4 ovcasw22r1 down down None auto Ethernet1/4 ovcasw23r1 down down None auto Ethernet1/5/1 ovcasw22r1 up up 151 10G Ethernet1/5/1 ovcasw23r1 up up 151 10G Ethernet1/5/2 ovcasw22r1 down up 151 10G Ethernet1/5/2 ovcasw23r1 down up 151 10G Ethernet1/5/3 ovcasw22r1 down down None 10G Ethernet1/5/3 ovcasw23r1 down down None 10G Ethernet1/5/4 ovcasw22r1 down down None 10G Ethernet1/5/4 ovcasw23r1 down down None 10G ----------------- 16 rows displayed Status: Success
Example 3.31 List Uplink Port Groups
PCA> list uplink-port-group Port_Group_Name Ports Mode Speed Breakout_Mode Enabled State --------------- ----- ---- ----- ------------- ------- ----- default_5_1 5:1 5:2 LAG 10g 10g-4x True (up)* Not all ports are up default_5_2 5:3 5:4 LAG 10g 10g-4x False down ---------------- 2 rows displayed Status: Success
Example 3.32 List All Configuration Errors
PCA> list config-error ID Module Host Timestamp -- ------ ---- --------- 87 Management node password 192.168.4.4 Mon Jun 03 02:45:42 2019 54 MySQL management password 192.168.4.216 Mon Jun 03 02:44:54 2019 ---------------- 2 rows displayed Status: Success
Removes a compute node from an existing tenant group.
Syntax
remove compute-node
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 compute nodes from,
and node is the name of the compute node that
should be removed from the selected tenant group.
Description
Use the remove compute-node command to remove the required compute 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 compute node, 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.33 Removing a Compute Node from a Tenant Group
PCA> remove compute-node ovcacn09r1 myTenantGroup
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: SuccessDisconnects 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.34 Disconnecting a Compute Node from a Custom Network
PCA> remove networkMyNetworkovcacn09r1************************************************************ 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.35 Removing a Custom Network from a Tenant Group
PCA> remove network-from-tenant-groupmyPublicNetworkmyTenantGroup************************************************************ 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.41, “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.36 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 The reprovision job has been submitted. Use "show compute-node <compute node name>" to monitor the progress. 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.32, “List All Configuration Errors” 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.41, “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. Caution Make sure that the new path to the log file exists. Otherwise, the log server stops working.
The system always prepends
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, WARNING. This property can be defined separately for the following log files: backup, cli, diagnosis, monitor, ovca, snmp, and syncservice. Use tab completion to insert the log file in the command before the log level value. |
| Set the value for the maximum log size before a log is rotated |
| Set the time zone for the location of the Oracle Private Cloud Appliance. There are several hundred options, and the selection is case sensitive. It is suggested to use tab completion to find the most accurate setting for your location. |
| 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.38 Changing the location of the sync service log file
PCA> set system-property log_file syncservice sync/ovca-sync.log
Status: Success
PCA> show system-properties
----------------------------------------
[...]
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/sync/ovca-sync.log
Sync.Log_Level DEBUG
Diagnosis.Log_File /var/log/ovca-diagnosis.log
Diagnosis.Log_Level DEBUG
[...]
----------------------------------------
Status: Success
Log configuration through the CLI is described in more detail in Section 6.1, “Setting the Oracle Private Cloud Appliance Logging Parameters”.
Example 3.39 Configuring and unconfiguring an HTTP proxy
PCA> set system-property http_proxy http://10.1.1.11:8080 Status: Success PCA> set system-property http_proxy '' Status: Success
Proxy configuration through the CLI is described in more detail in Section 6.2, “Adding Proxy Settings for Oracle Private Cloud Appliance Updates”.
Example 3.40 Configuring the Oracle Private Cloud Appliance 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 {
compute-node
|
network
|
rack-layout
|
system-properties
|
task
|
tenant-group
|
version
}
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 |
|---|---|
compute-node | Compute Node Name |
network | Network Name |
rack-layout | Rack Architecture or Type |
system-properties | (none) |
task | Task ID |
tenant-group | Tenant Group Name |
version | (none) |
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.41 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 Etc/UTC 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 INFO Snmp.Log_File /nfs/shared_storage/logs/ovca_snmptrapd.log Snmp.Log_Level DEBUG ---------------------------------------- Status: Success
Example 3.42 Show Task
PCA> show task 341e7bc74f339c ---------------------------------------- Task_Name backup Status RUNNING Progress 70 Start_Time 05-27-2019 09:59:36 End_Time None Pid 1503341 Result None ---------------------------------------- Status: Success
Example 3.43 Show Rack Layout
PCA> show rack-layout x8-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 N / A infrastructure filler [25, 24] 24 N / A infrastructure filler [25, 24] 23 ovcasw23r1 infrastructure cisco-data cisco4 [23] 22 ovcasw22r1 infrastructure cisco-data cisco3 [22] 21 ovcasw21r1 infrastructure cisco [21] 20 N / A infrastructure zfs-storage disk-shelf [20, 19, 18, 17] 19 N / A infrastructure zfs-storage disk-shelf [20, 19, 18, 17] 18 N / A infrastructure zfs-storage disk-shelf [20, 19, 18, 17] 17 N / A infrastructure zfs-storage disk-shelf [20, 19, 18, 17] 16 ovcasw16r1 infrastructure cisco-data cisco2 [16] 15 ovcasw15r1 infrastructure cisco-data cisco1 [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 ovcasn02r1 infrastructure zfs-storage zfs-head2 [4, 3] 3 ovcasn02r1 infrastructure zfs-storage zfs-head2 [4, 3] 2 ovcasn01r1 infrastructure zfs-storage zfs-head1 [2, 1] 1 ovcasn01r1 infrastructure zfs-storage zfs-head1 [2, 1] 0 ovcapduBr1 infrastructure pdu pdu2 [0] 0 ovcapduAr1 infrastructure pdu pdu1 [0] ----------------- 44 rows displayed Status: Success
Example 3.44 Show the Configuration Details of the default_external Network
PCA> show network default_external ---------------------------------------- Network_Name default_external Trunkmode None Description None Ports ['5:1', '5:2'] vNICs None Status ready Network_Type external_network Compute_Nodes ovcacn12r1, ovcacn07r1, ovcacn13r1, ovcacn14r1, ovcacn10r1, ovcacn09r1, ovcacn11r1 Prefix 192.168.200.0/21 Netmask None Route_Destination None Route_Gateway None ---------------------------------------- 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 None
Tenant_Networks ['myPublicNetwork']
Pool_Filesystem_ID 3600144f0d29d4c86000057162ecc0001
----------------------------------------
Status: SuccessExample 3.46 Show Details of a Custom Network
PCA> show network myHostNetwork
----------------------------------------
Network_Name myHostNetwork
Trunkmode None
Description None
Ports ['1', '2']
vNICs None
Status ready
Network_Type host_network
Compute_Nodes ovcacn42r1, ovcacn01r2, ovcacn02r2
Prefix 10.10.10
Netmask 255.255.240.0
Route_Destination 10.10.20.0/24
Route_Gateway 10.10.10.250
----------------------------------------
Status: SuccessExample 3.47 Show Oracle PCA Version Information
PCA> show version ---------------------------------------- Version 2.4.1 Build 819 Date 2019-06-20 ---------------------------------------- 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.49 Aborting a Task
PCA> stop task 341d45b5424c16 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
This command is deprecated. Its functionality is part of the Oracle Private Cloud Appliance Upgrader.
Release 2.4.1 is for factory installation only. It cannot be used for field updates or upgrade operations on existing appliance environments.
Modifies the password for one or more components within the Oracle Private Cloud Appliance.
Syntax
update password {
LeafSwitch-admin
|
MgmtNetSwitch-admin
|
SpineSwitch-admin
|
mgmt-root
|
mysql-appfw
|
mysql-ovs
|
mysql-root
|
ovm-admin
|
spCn-root
|
spMn-root
|
spZfs-root
|
system-root
|
wls-weblogic
|
zfs-root
} [
PCA-password
target-password
] [
--confirm
] [
--json
] [
--less
] [
--more
] [
--tee=OUTPUTFILENAME
]
where PCA-password is the current password of
the Oracle Private Cloud Appliance 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 Private Cloud Appliance password and the new target component password with the command. If not, you are prompted for the current password of the Oracle Private Cloud Appliance admin user and for the new password that should be applied to the target.
Password changes are not instantaneous across the appliance, but are propagated through a task queue. When applying a password change, allow at least 30 minutes for the change to take effect. Do not attempt any further password changes during this delay. Verify that the password change has been applied correctly.
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
The |
|
Sets a new password for the
The |
|
Sets a new password for the
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
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.50 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