4 Oracle Private Cloud Appliance Command Line Interface (CLI)
All Private Cloud Appliance command line utilities are
consolidated into a single command line interface that is accessible via the management node
shell by running the pca-admin command located at
/usr/sbin/pca-admin. This command is in the system path for the root
user, so you should be able to run the command from anywhere that you are located on a
management node. The CLI provides access to all of the tools available in the Oracle Private
Cloud Appliance Dashboard, as well as many that do not have a Dashboard equivalent. The design
of the CLI makes it possible to script actions that may need to be performed more regularly,
or to write integration scripts with existing monitoring and maintenance software not directly
hosted on the appliance.
It is important to understand that the CLI, described here, is distinct from the Oracle VM Manager command line interface, which is described fully in the Oracle VM Manager Command Line Interface User's Guide.
In general, it is preferable that CLI usage is restricted to the active management node. While it is possible to run the CLI from either management node, some commands are restricted to the active management node and return an error if you attempt to run them on the passive management node.
CLI Usage
The Oracle Private Cloud Appliance command line interface is triggered by
running the pca-admin command. It can run
either in interactive mode (see
Interactive Mode) or in
single-command mode (see
Single-command Mode) depending on
whether you provide the syntax to run a particular CLI command
when you invoke the command line interpreter.
The syntax when using the CLI is as follows:
PCA> Command Command_Target <Arguments> Options
where:
-
Command is the command type that should be initiated. For example
list; -
Command_Target is the Oracle Private Cloud Appliance component or process that should be affected by the command. For example management-node, compute-node, task etc;
-
<Arguments> consist of positioning arguments related to the command target. For instance, when performing a reprovisioning action against a compute node, you should provide the specific compute node that should be affected as an argument for this command. For example:
reprovision compute-node ovcacn11r1; -
Options consist of options that may be provided as additional parameters to the command to affect its behavior. For instance, the
listcommand provides various sorting and filtering options that can be appended to the command syntax to control how output is returned. For example:list compute-node --filter-column Provisioning_State --filter dead. See Controlling CLI Output for more information on many of these options.
The CLI includes its own internal help that can assist you with understanding the commands, command targets, arguments and options available. See Internal CLI Help for more information on how to use this help system. When used in interactive mode, the CLI also provides tab completion to assist you with the correct construction of a command. See Tab Completion for more information on this.
Interactive Mode
The Oracle Private Cloud Appliance command line interface (CLI) provides an
interactive shell that can be used for user-friendly command
line interactions. This shell provides a closed environment
where users can enter commands specific to the management of the
Oracle Private Cloud Appliance. By using the CLI in interactive mode, the user
can avail of features like tab completion to easily complete
commands correctly. By default, running the
pca-admin command without providing any
additional parameters causes the CLI interpreter to run in
interactive mode.
It is possible to identify that you are in a CLI shell running in interactive mode as the shell prompt is indicated by PCA>.
Example 4-1 An example of interactive mode usage of the CLI
# pca-admin Welcome to PCA! Release: 2.4.1 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 Yes ovcamn06r1 192.168.4.4 RUNNING 00:10:e0:e7:26:ad running None ---------------- 2 rows displayed Status: Success PCA> exit #
To exit from the CLI when it is in interactive mode, you can use
either the q, quit, or
exit command, or alternatively use the Ctrl+D
key combination.
Tab Completion
The CLI supports tab-completion when in interactive mode. This means that pressing the tab key while entering a command can either complete the command on your behalf, or can indicate options and possible values that can be entered to complete a command. Usually you must press the tab key at least twice to effect tab-completion.
ab-completion is configured to work at all levels within the CLI and is context sensitive. This means that you can press the tab key to complete or prompt for commands, command targets, options, and for certain option values. For instance, pressing the tab key twice at a blank prompt within the CLI automatically lists all possible commands, while pressing the tab key after typing the first letter or few letters of a command automatically completes the command for you. Once a command is specified, followed by a space, pressing the tab key indicates command targets. If you have specified a command target, pressing the tab key indicates other options available for the command sequence. If you press the tab key after specifying a command option that requires an option value, such as the --filter-column option, the CLI attempts to provide you with the values that can be used with that option.
Example 4-2 Examples showing tab-completion
PCA> tab EOF backup create deprovision exit help q remove rerun shell start update add configure delete diagnose get list quit reprovision set show stop PCA> list tab compute-node lock mgmt-switch-port network-port task update-task uplink-port-group config-error management-node network network-switch tenant-group uplink-port PCA> list comtabpute-node
The <tab> indicates where the user pressed the tab key while in an interactive CLI session. In the final example, the command target is automatically completed by the CLI.
Running Shell Commands
It is possible to run standard shell commands while you are in
the CLI interpreter shell. These can be run by either
preceding them with the shell command or by
using the ! operator as a shortcut to
indicate that the command that follows is a standard shell
command. For example:
PCA> shell date Wed Jun 5 08:15:56 UTC 2019 PCA> !uptime > /tmp/uptime-today PCA> !rm /tmp/uptime-today
Single-command Mode
The CLI supports 'single-command mode', which allows you to execute a single command from the shell via the CLI and to obtain the output before the CLI exits back to the shell. This is particularly useful when writing scripts that may interact with the CLI, particularly if used in conjunction with the CLI's JSON output mode described in JSON Output.
To run the CLI in single-command mode, simply include the full
command syntax that you wish to execute as parameters to the
pca-admin command.
An example of single command mode is provided below:
# pca-admin list compute-node Compute_Node IP_Address Provisioning_Status ILOM_MAC Provisioning_State ------------ ---------- ------------------- -------- ------------------ ovcacn12r1 192.168.4.8 RUNNING 00:10:e0:e5:e6:d3 running ovcacn07r1 192.168.4.7 RUNNING 00:10:e0:e6:8d:0b running ovcacn13r1 192.168.4.11 RUNNING 00:10:e0:e6:f7:f7 running ovcacn14r1 192.168.4.9 RUNNING 00:10:e0:e7:15:eb running ovcacn10r1 192.168.4.12 RUNNING 00:10:e0:e7:13:8d running ovcacn09r1 192.168.4.6 RUNNING 00:10:e0:e6:f8:6f running ovcacn11r1 192.168.4.10 RUNNING 00:10:e0:e6:f9:ef running ---------------- 7 rows displayed #
Controlling CLI Output
The CLI provides options to control how output is returned in responses to the various CLI commands that are available. These are provided as additional options as the final portion of the syntax for a CLI command. Many of these options can make it easier to identify particular items of interest through sorting and filtering, or can be particularly useful when scripting solutions as they help to provide output that is more easily parsed.
JSON Output
JSON format is a commonly used format to represent data objects in a way that is easy to machine-parse but is equally easy for a user to read. Although JSON was originally developed as a way to represent JavaScript objects, parsers are available for a wide number of programming languages, making it an ideal output format for the CLI if you are scripting a custom solution that may need to interface directly with the CLI.
The CLI returns its output for any command in JSON format if the --json option is specified when a command is run. Typically this option may be used when running the CLI in single-command mode. An example follows:
# pca-admin list compute-node --json
{
"00:10:e0:e5:e6:ce": {
"name": "ovcacn12r1",
"ilom_state": "running",
"ip": "192.168.4.8",
"tenant_group_name": "Rack1_ServerPool",
"state": "RUNNING",
"networks": "default_external, default_internal",
"ilom_mac": "00:10:e0:e5:e6:d3"
},
"00:10:e0:e6:8d:06": {
"name": "ovcacn07r1",
"ilom_state": "running",
"ip": "192.168.4.7",
"tenant_group_name": "Rack1_ServerPool",
"state": "RUNNING",
"networks": "default_external, default_internal",
"ilom_mac": "00:10:e0:e6:8d:0b"
},
[...]
"00:10:e0:e6:f9:ea": {
"name": "ovcacn11r1",
"ilom_state": "running",
"ip": "192.168.4.10",
"tenant_group_name": "",
"state": "RUNNING",
"networks": "default_external, default_internal",
"ilom_mac": "00:10:e0:e6:f9:ef"
}
}In some cases the JSON output may contain more information than is displayed in the tabulated output that is usually shown in the CLI when the --json option is not used. Furthermore, the keys used in the JSON output may not map identically to the table column names that are presented in the tabulated output.
Sorting and filtering options are currently not supported in conjunction with JSON output, since these facilities can usually be implemented on the side of the parser.
Sorting
Typically, when using the list command, you
may wish to sort information in a way that makes it easier to
view items of particular interest. This is achieved using the
--sorted-by and
--sorted-order options in conjunction with
the command. When using the --sorted-by
option, you must specify the column name against which the
sort should be applied. You can use the
--sorted-order option to control the
direction of the sort. This option should be followed either
with ASC for an ascending sort, or DES for a descending sort.
If this option is not specified, the default sort order is
ascending.
For example, to sort a view of compute nodes based on the status of the provisioning for each compute node, you may do the following:
PCA> list compute-node --sorted-by Provisioning_State --sorted-order ASC Compute_Node IP_Address Provisioning_Status ILOM_MAC Provisioning_State ------------ ---------- ---------- -------- ---------- ovcacn08r1 192.168.4.9 RUNNING 00:10:e0:65:2f:b7 dead ovcacn28r1 192.168.4.10 RUNNING 00:10:e0:62:31:81 initializing_stage_wait_for_hmp ovcacn10r1 192.168.4.7 RUNNING 00:10:e0:65:2f:cf initializing_stage_wait_for_hmp ovcacn30r1 192.168.4.8 RUNNING 00:10:e0:40:cb:59 running ovcacn07r1 192.168.4.11 RUNNING 00:10:e0:62:ca:09 running ovcacn26r1 192.168.4.12 RUNNING 00:10:e0:65:30:f5 running ovcacn29r1 192.168.4.5 RUNNING 00:10:e0:31:49:1d running ovcacn09r1 192.168.4.6 RUNNING 00:10:e0:65:2f:3f running ---------------- 8 rows displayed Status: Success
Note that you can use tab-completion with the --sorted-by option to easily obtain the options for different column names. See Tab Completion for more information.
Filtering
Some tables may contain a large number of rows that you are not interested in, to limit the output to items of particular interest you can use the filtering capabilities that are built into the CLI. Filtering is achieved using a combination of the --filter-column and --filter options. The --filter-column option must be followed by specifying the column name, while the --filter option is followed with the specific text that should be matched to form the filter. The text that should be specified for a --filter may contain wildcard characters. If that is not the case, it must be an exact match. Filtering does not currently support regular expressions or partial matches.
For example, to view only the compute nodes that have a Provisioning state equivalent to 'dead', you could use the following filter:
PCA> list compute-node --filter-column Provisioning_State --filter dead Compute_Node IP_Address Provisioning_Status ILOM_MAC Provisioning_State ------------ ---------- ---------- -------- ---------- ovcacn09r1 192.168.4.10 DEAD 00:10:e0:0f:55:cb dead ovcacn11r1 192.168.4.9 DEAD 00:10:e0:0f:57:93 dead ovcacn14r1 192.168.4.7 DEAD 00:10:e0:46:9e:45 dead ovcacn36r1 192.168.4.11 DEAD 00:10:e0:0f:5a:9f dead ---------------- 4 rows displayed Status: Success
Note that you can use tab-completion with the --filter-column option to easily obtain the options for different column names. See Tab Completion for more information.
Internal CLI Help
The CLI includes its own internal help system. This is triggered
by issuing the help command:
PCA> help Documented commands (type help <topic>): ======================================== add create diagnose list rerun start backup delete get remove set stop configure deprovision help reprovision show update Undocumented commands: ====================== EOF exit q quit shell
The help system displays all of the available commands that are
supported by the CLI. These are organized into 'Documented
commands' and 'Undocumented commands'. Undocumented commands are
usually commands that are not specific to the management of the
Oracle Private Cloud Appliance, but are mostly discussed within this
documentation. Note that more detailed help can be obtained for
any documented command by appending the name of the command to
the help query. For example, to obtain the
help documentation specific to the list command, you can do the
following:
PCA> help list
Usage: pca-admin list <Command Target> [OPTS]
Command Targets:
compute-node List computer node.
config-error List configuration errors.
lock List lock.
management-node List management node.
mgmt-switch-port List management switch port.
network List active networks.
network-port List network port.
network-switch List network switch.
task List task.
tenant-group List tenant-group.
update-task List update task.
uplink-port List uplink port.
uplink-port-group List uplink port group.
Options:
--json Display the output in json format.
--less Display output in the less pagination mode.
--more Display output in the more pagination mode.
--tee=OUTPUTFILENAME Export output to a file.
--sorted-by=SORTEDBY Sorting the table by a column.
--sorted-order=SORTEDORDER
Sorting order.
--filter-column=FILTERCOLUMN
Table column that needs to be filtered.
--filter=FILTER filter criterion
You can drill down further into the help system for most
commands by also appending the command target onto your
help query:
PCA> help reprovision compute-node Usage: reprovision compute-node <compute node name> [options] Example: reprovision compute-node ovcacn11r1 Description: Reprovision a compute node.
Finally, if you submit a help query for something that doesn't exist, the help system generates an error and automatically attempts to prompt you with alternative candidates:
PCA> list ta Status: Failure Error Message: Error (MISSING_TARGET_000): Missing command target for command: list. Command targets can be: ['update-task', 'uplink-port-group', 'config-error', 'network', 'lock', 'network-port', 'tenant-group', 'network-switch', 'task', 'compute-node', 'uplink-port', 'mgmt-switch-port', 'management-node'].
CLI Commands
This section describes all of the documented commands available via the CLI.
add compute-node
Adds a compute node to an existing tenant group. To create a new tenant group, see create tenant-group.
Syntax
add compute-node node tenant-group-name [OPTIONS]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.
During add compute-node operations, Kubernetes
cluster operations should not be underway or started. If
existing Kubernetes clusters are in the tenant group, there will
be a period after the compute node is added and the
K8S_Private network is connected that the
existing Kubernetes private cluster networks are extended. The
Kubernetes private network extension is done asynchronously
outside of the compute-node add.
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 |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-3 Adding a Compute Node to a Tenant Group
PCA> add compute-node ovcacn09r1 myTenantGroup
Status: Success
add initiator
Adds an initiator to an iSCSI LUN. This allows you to control access to the iSCSI LUN shares you created on the internal ZFS Storage Appliance.
Syntax
add initiator initiator-IQN LUN-name [OPTIONS]LUN-name is the name of the iSCSI LUN share to which you are
granting access using an initiator.
Description
Use the add initiator command to add an initiator to an iSCSI LUN. This
command creates an initiator with the provided IQN in the ZFS Storage Appliance and adds it to initiator group associated with
an iSCSI share.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
initiator-IQN
|
List the initiator IQN from the virtual machine you want to have access to the LUN. Only virtual machines within the same subnet/network can have access to the filesystem. |
LUN-name
|
Specify the LUN you want to make available using an initiator. |
--json
|
Return the output of the command in JSON format. |
--less
|
Return the output of the command one screen at a time for easy viewing, as with the
|
--more
|
Return the output of the command one screen at a time for easy viewing, as with the
|
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-4 Adding an Initiator to a LUN
PCA> add initiator iqn.example.com myLUN Status: Success
add network
Connects a server node to an existing network. To create a new custom network, see create network.
Syntax
add network network-name node [OPTIONS]
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 |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-5 Connecting a Compute Node to a Custom Network
PCA> add network MyNetwork ovcacn09r1 Status: Success
add network-to-tenant-group
Associates a custom network with an existing tenant group. To create a new tenant group, see create tenant-group. To create a new custom network, see create network.
Syntax
add network-to-tenant-group network-name tenant-group-name [OPTIONS] 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.
Note:
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 |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-6 Associating a Custom Network with a Tenant Group
PCA> add network-to-tenant-group myPublicNetwork myTenantGroup Validating servers in the tenant group... This may take some time. The job for sync all nodes in tenant group with the new network myPublicNetwork has been submitted. Please look into "/var/log/ovca.log" and "/var/log/ovca-sync.log" to monitor the progress. Status: Success
add nfs-exception
Adds an NFS exception to allowed clients list for an NFS share. This allows you to control access to the internal ZFS storage appliance by granting exceptions to particular groups of users.
Syntax
add nfs-exception network-or-IP-address [OPTIONS] where nfs-share-name is the name of the NFS share to which you are granting access using exceptions.
Description
Use the add nfs-exception command to grant a client access to the NFS
share.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
network or IP address
|
List the IP address or CIDR you want to have access to the share. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-7 Adding an NFS Share Exception
PCA> add nfs-exception MyNFSshare 172.16.4.0/24 Status: Success
backup
Triggers a manual backup of the Oracle Private Cloud Appliance.
Note:
The backup command can only be executed from the active management node; not from the standby management node.
Syntax
backup [OPTIONS] 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 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 4-57 for more information.
Options
There are no further options for this command.
| Option | Description |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-8 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
create iscsi-storage
Creates a new iSCSI LUN share for a VM storage network.
Syntax
create iscsi-storage storage_network_name LUN_size storage-profile [OPTIONS] where iscsi-LUN-name is the name of the iSCSI LUN share you wish to create.
Description
Use this command to create an iSCSI LUN share associated with a particular network. This iSCSI LUN share can then be used by Virtual Machines that have access to the specified network.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
storage_network_name
|
The name of the storage network where you wish to create the share. |
share_size
|
The size of the share in Gigabytes, for example 100G. |
storage-profile
|
Optionally, you can choose a pre-configured storage profile to maximize I/O performance for your environment. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-9 Creating an iSCSI LUN Share
PCA> create iscsi-storage my_iscsi_LUN myStorageNnetwork 100G general Status: Success
create lock
Imposes a lock on certain appliance functionality.
Caution:
Never use locks without consultation or specific instructions from Oracle Support.
Syntax
create lock lock-type [OPTIONS] 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 |
|---|---|
all_provisioning
|
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. |
cn_upgrade
|
Prevent all compute node upgrade operations. |
database
|
Impose a lock on the databases during the management node update process. The lock is released after the update. |
install
|
Placeholder lock type. Currently not used. |
manufacturing
|
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 |
mn_upgrade
|
Prevent all management node upgrade operations. |
provisioning
|
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. |
service
|
Placeholder lock type. Behavior is identical to manufacturing lock. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-10 Imposing a Provisioning Lock
PCA> create lock provisioning Status: Success
create network
Creates a new custom network, private or public, at the appliance level. See Network Customization for detailed information.
Syntax
create network network-name network-type [OPTIONS] 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 create uplink-port-group for more information.
If the network type is storage_network, then mandatory additional arguments
are expected. Enter the prefix, netmask and the [zfs-ipaddress] that is assigned to the ZFS
storage appliance network interface.
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 netmask -
netmask: 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 |
|---|---|
{ rack_internal_network | external_network | storage_network | host_network
}
|
The type of custom network to create. The options are:
|
external_network port-group
|
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. |
storage_network prefix netmask [zfs-ipaddress]
|
To create a storage network, you must specify the prefix, netmask, and the ip address that is assigned to the ZFS storage appliance network interface. |
host_network port-group prefix netmask [route-destination gateway]
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-11 Creating an Internal Custom Network
PCA> create network MyPrivateNetwork rack_internal_network
Status: Success
Example 4-12 Creating a Custom Network with External Connectivity
PCA> create network MyPublicNetwork external_network myUplinkPortGroup Status: Success
Example 4-13 Creating a Storage Network
PCA> create network MyStorageNetwork storage_network 10.10.10 255.255.255.0 10.10.10.1
Status: Success
create nfs-storage
Creates a new NFS storage share for a VM storage network.
Syntax
create nfs-storage nfs-share-name storage_network_name share_size storage-profile [OPTIONS]where nfs-share-name is the name of the NFS share you wish to create.
Description
Use this command to create an NFS share accosciated with a particular network. This NFS share can then be used by Virtual Machines that have access to the specified network.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
storage_network_name
|
The name of the storage network where you wish to create the share. |
share_size
|
The size of the share in Gigabytes, for example 100G. |
storage-profile
|
Optionally, you can choose a pre-configured storage profile to maximize I/O performance for your environment. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-14 Creating an NFS Share
PCA> create nfs-storage myShare myStorageNnetwork 100G general Status: Success
create oci-backup
Creates an on-demand Oracle Cloud Infrastructure dataset backup. For more information, see Configuring a Manual Cloud Backup.
Syntax
create oci-backup target-name target-name-2 [OPTIONS]where target-name is the name of the Oracle Cloud Infrastructure target where you wish to locate the backup.
Description
Use this command to create an Oracle Cloud Infrastructure backup. You can push a backup to multiple configured targets by listing mutlitple targets with this command. To configure targets, see Configuring the Cloud Backup Service.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-15 Creating an Oracle Cloud Infrastructure Backup
PCA> create oci-backup OCItarget_1 OCItarget_2 Status: Success
create oci-target
Creates an Oracle Cloud Infrastructure target, which is the location on your Oracle Cloud Infrastructure tenancy where you want to store backups.
Syntax
create oci-target target-name target-location target-user target-bucket target-tenancy keyfile [OPTIONS] where target-name is the name of the Oracle Cloud Infrastructure target where you wish to locate the backup.
Description
Use this command to create an Oracle Cloud Infrastructure target, and to send scheduled backups to that target. This command creates a cronjob which pushed this backup to the configured target weekly. For more information see Configuring the Cloud Backup Service.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
|
|
The object storage endpoint. For a list of available endpoints, see https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/. |
|
|
A user that has access to your Oracle Cloud Infrastructure tenancy. |
|
|
A logical container for storing objects. Users or systems create buckets as needed within a region. See Managing Regions. To create a bucket for the Cloud Backup feature, see Configuring the Cloud Backup Service. |
|
|
Your Oracle Cloud Infrastructure tenancy where you wish to store backups. |
|
|
An API key required to access your Oracle Cloud Infrastructure tenancy. For more information see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-16 Creating an Oracle Cloud Infrastructure Target
PCA> create oci-target MyTarget https://objectstorage.us-oci.com ocid1.user.oc1..oos mybucketocid1.tenancy.oc1..no /root/oci_api_key.pem
Status: Success
create tenant-group
Creates a new tenant group. With the tenant group, which exists at the appliance level, a corresponding Oracle VM server pool is created. See Tenant Groups for detailed information.
Syntax
create tenant-group tenant-group-name [OPTIONS]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 |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-17 Creating a Tenant Group
PCA> create tenant-group myTenantGroup
Status: Success
create uplink-port-group
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 Network Requirements in the Oracle Private Cloud Appliance Installation Guide.
Syntax
create uplink-port-group port-group-name ports port-speed [OPTIONS]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 |
|---|---|
ports
|
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: |
{ 10g-4x | 25g-4x | 40g | 100g }
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-18 Creating an Uplink Port Group
PCA> create uplink-port-group myUplinkPortGroup '3:1 3:2' 10g-4x Status: Success PCA> create uplink-port-group myStoragePortGroup '1 2' 40g Status: Success
delete config-error
The delete config-error command can be used
to delete a failed configuration task from the configuration
error database.
Syntax
delete config-error id [OPTIONS] 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 4-44
for more information.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-19 Removing a Configuration Error
PCA> delete config-error 87 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
delete iscsi-storage
Deletes an iSCSI LUN share for a VM storage network.
Syntax
delete iscsi-storage iscsi-LUN-namewhere iscsi-LUN-name is the name of the iSCSI LUN share you wish to delete.
Description
Use this command to permanently delete an iSCSI LUN share.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-20 Deleting an iSCSI LUN Share
PCA> delete iscsi-storage my_iscsi_LUN
Status: Success
delete lock
Removes a lock that was previously imposed on certain appliance functionality.
Syntax
delete lock lock-type [OPTIONS]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 |
|---|---|
{ all_provisioning | cn_upgrade | database |
install | manufacturing | mn_upgrade | provisioning | service }
|
The type of lock to be removed. For a description of lock types, see create lock. |
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Example
Example 4-21 Unlocking Provisioning
PCA> delete lock provisioning ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
delete network
Deletes a custom network. See Network Customization for detailed information.
Syntax
delete network network-name [OPTIONS] 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 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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-22 Deleting a Custom Network
PCA> delete network MyNetwork
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: Success
Example 4-23 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.']
delete nfs-storage
Deletes an NFS storage share for a VM storage network.
Syntax
delete nfs-storage nfs-share-namewhere nfs-share-name is the name of the NFS storage share you wish to delete.
Description
Use this command to permanently delete an NFS storage share.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-24 Deleting an NFS Storage Share
PCA> delete nfs-storage myStorageShare
Status: Success
delete oci-backup
Deletes an Oracle Cloud Infrastructure dataset backup. For more information, see Deleting Cloud Backups.
Syntax
delete oci-backup oci-backup-name [OPTIONS]where oci-backup-name is the name of the Oracle Cloud Infrastructure backup you wish to delete.
Description
Use this command to permanently delete an Oracle Cloud Infrastructure backup.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-25 Deleting an Oracle Cloud Infrastructure Backup
PCA> delete oci-backup myOCIbackup
Status: Success
delete oci-target
Deletes an Oracle Cloud Infrastructure target from your ZFS storage appliance. For more information see Deleting Oracle Cloud Infrastructure Targets .
Syntax
delete oci-target oci-target-name [OPTIONS]where oci-target-name is the name of the Oracle Cloud Infrastructure target you wish to delete.
Description
Use this command to permanently delete an Oracle Cloud Infrastructure target.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-26 Deleting an Oracle Cloud Infrastructure Target
PCA> delete nfs-storage myStorageShare
Status: Success
delete task
The delete command can be used to delete a
task from the database.
Syntax
delete task idwhere 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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-27 Removing a Task
PCA> delete task 341e7bc74f339c ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
delete tenant-group
Deletes a tenant group. The default tenant group cannot be deleted. See Tenant Groups for detailed information.
Syntax
delete tenant-group tenant-group-name [OPTIONS]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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-28 Deleting a Tenant Group
PCA> delete tenant-group myTenantGroup
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: Success
delete uplink-port-group
Deletes an uplink port group. See create uplink-port-group for more information about the use of uplink port groups.
Syntax
delete uplink-port-group port-group-name [OPTIONS]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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-29 Deleting an Uplink Port Group
PCA> delete uplink-port-group myUplinkPortGroup
************************************************************
WARNING !!! THIS IS A DESTRUCTIVE OPERATION.
************************************************************
Are you sure [y/N]:y
Status: Success
deprovision compute-node
Cleanly 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 [OPTIONS]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.
Caution:
For deprovisioning to succeed, the compute node ILOM password must be the default password. 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 create lock and 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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-30 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
diagnose
Performs various diagnostic checks against the Oracle Private Cloud Appliance for support purposes.
Caution:
The diagnose software command is deprecated. It will be removed in the
next release of the Oracle Private Cloud Appliance Controller Software. Diagnostic functions
are now available through a separate health check tool. See Health Monitoring for more
information.
The other diagnose commands remain functional.
Syntax
diagnose { ilom | software | hardware | rack-monitor } [OPTIONS] The following table describes each possible target of the diagnose
command.
| Command Target | Information Displayed |
|---|---|
|
|
The
|
|
|
The |
|
|
The |
|
|
The |
|
|
The |
|
|
The If required, the results can be filtered by component type (cn, ilom, mn, etc.) Use tab completion to see all component types available. |
|
|
The |
|
|
The |
|
|
The |
|
|
The
|
|
|
The |
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 |
|---|---|
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
--tests=TESTS
|
Returns the output of specific tests you designate, rather than running the full set of tests. |
--version=VERSION
|
Defines what version of software the command will run on. The default version is 2.4.2, but you can run the command on other version you specify here. |
Examples
Example 4-31 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: Success
Example 4-32 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
Example 4-33 Running the Leaf-Switch Diagnostic
PCA> diagnose leaf-switch Switch Health Check Name Status ------ ----------------- ------ ovcasw15r1 CDP Neighbor Check Passed ovcasw15r1 Virtual Port-channel check Passed ovcasw15r1 Management Node Port-channel check Passed ovcasw15r1 Leaf-Spine Port-channel check Passed ovcasw15r1 OSPF Neighbor Check Passed ovcasw15r1 Multicast Route Check Passed ovcasw15r1 Leaf Filesystem Check Passed ovcasw15r1 Hardware Diagnostic Check Passed ovcasw16r1 CDP Neighbor Check Passed ovcasw16r1 Virtual Port-channel check Passed ovcasw16r1 Management Node Port-channel check Passed ovcasw16r1 Leaf-Spine Port-channel check Passed ovcasw16r1 OSPF Neighbor Check Passed ovcasw16r1 Multicast Route Check Passed ovcasw16r1 Leaf Filesystem Check Passed ovcasw16r1 Hardware Diagnostic Check Passed ----------------- 16 rows displayed Status: Success
get log
Retrieves the log files from the selected components and saves them to a directory on the rack's shared storage.
Note:
Currently the spine or data switch is the only target component supported with this command.
Syntax
get log component [OPTIONS]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 |
|---|---|
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-34 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
list
The list command can be used to list the different components and tasks
within the Oracle Private Cloud Appliance. 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 target [OPTIONS] The following table describes each possible target of the list command.
| Command Target | Information Displayed |
|---|---|
|
|
Displays basic information about all backup tasks. |
|
|
Displays basic information for all compute nodes installed. |
|
|
Displays all configuration tasks that were not completed successfully and ended in an error. |
|
|
Displays all iSCSI LUNs for storage. |
|
|
Displays all locks that have been imposed. |
|
|
Displays basic information for both management nodes. |
|
|
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. |
|
|
Displays all networks configured in the environment. |
|
|
Displays the status of all ports on all I/O modules installed in the networking components. |
|
|
Displays basic information about all switches installed in the Oracle Private Cloud Appliance environment. |
|
|
Displays NFS shares for storage. |
|
|
Displays all the Oracle Cloud Infrastructure backups. |
|
|
Displays a list of known storage networks. |
|
|
Displays all the storage profiles. |
|
|
Displays a list of running, completed and failed tasks. |
|
|
Displays all configured tenant groups. The list includes the default configuration as well as custom tenant groups. |
|
|
Displays a list of all software update tasks that have been started on the appliance. |
|
|
Displays information about spine switch port configurations for external networking. |
|
|
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 |
|---|---|
list { backup-task | compute-node | config-error | iscsi-storage | lock |
management-node | mgmt-switch-port | network | network-card | network-port |
network-switch | nfs-storage | oci-backup | oci-target | ofm-network | opus-port |
storage-network | storage-profile | task | tenant-group | update-task | uplink-port
| uplink-port-group | wwpn-info } [ --json ] [ --less ] [ --more ] [
--tee=OUTPUTFILENAME ] [ [ --sorted-by SORTEDBY | --sorted-order SORTEDORDER ] ] [ [
--filter-column FILTERCOLUMN | --filter FILTER ] ]
|
The command target to list information for. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
[ --sorted-by SORTEDBY ]
|
Sort the table by the values within a particular column in the table, specified by
replacing |
[ --sorted-order SORTEDORDER ]
|
Used to specify the sort order, which can either be |
[ --filter-column FILTERCOLUMN ]
|
Filter the table for a value within a particular column in the table, specified by
replacing |
[ --filter FILTER ]
|
The filter that should be applied to values within the column specified by the
|
Examples
Example 4-35 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 4-36 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 4-37 List All Tenant Groups
PCA> list tenant-group Name Default State ---- ------- ----- Rack1_ServerPool True ready myTenantGroup False ready ---------------- 2 rows displayed Status: Success
Example 4-38 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 4-39 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 4-40 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 4-41 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 4-42 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 4-43 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 4-44 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
Example 4-45 List All Storage Profiles
PCA> list storage-profile Name Type Default ---- ---- ------- dbms_demo iscsi N general iscsi Y bkup_basic iscsi N general nfs Y bkup_basic nfs N dbms_demo nfs N ---------------- 6 rows displayed Status: Success
remove compute-node
Removes a compute node from an existing tenant group.
Syntax
remove compute-node node tenant-group-name [OPTIONS]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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-46 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: Success
remove initiator
Removes an initiator from an iSCSI LUN, thereby removing access to the iSCSI LUN from that initiator.
Syntax
remove initiator initiator-IQN LUN-name [OPTIONS]LUN-name is the name of the iSCSI LUN share to which you are
revoking access for the listed initiator.
Description
Use the remove initiator command to remove an initiator from an iSCSI
LUN.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
initiator-IQN
|
List the initiator IQN from the virtual machine that should no longer have access to the LUN. |
LUN-name
|
Specify the LUN you want remove the initiator from. |
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format. |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-47 Removing an Initiator From a LUN
PCA> remove initiator iqn.example.com myLUN Status: Success
remove network
Disconnects a server node from a network.
Syntax
remove network network-name node [OPTIONS]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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-48 Disconnecting a Compute Node from a Custom Network
PCA> remove network MyNetwork ovcacn09r1 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
remove network-from-tenant-group
Removes a custom network from a tenant group.
Syntax
remove network-from-tenant-group network-name tenant-group-name [OPTIONS]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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-49 Removing a Custom Network from a Tenant Group
PCA> remove network-from-tenant-group myPublicNetwork myTenantGroup ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
remove nfs exceptions
Removes an NFS exception, thereby removing access to the NFS share from the listed machine.
Syntax
remove nfs-exception nfs-share-name [OPTIONS]where nfs-share-name is the name of the NFS share to which you
are granting access using exceptions.
Description
Use the remove nfs-exception command to remove an
nfs-exception from a share.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
network or IP address
|
List the IP address or CIDR that should no longer have access to the share. |
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format. |
--less
|
Return the output of the command one screen at a time for easy viewing, as with the
|
--more
|
Return the output of the command one screen at a time for easy viewing, as with the
|
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write the output to the specified output file. |
Examples
Example 4-50 Removing an NFS Exception From a Share
PCA> remove nfs-exception myNFSshare 172.16.4.0/24 Status: Success
reprovision
The reprovision command can be used to trigger reprovisioning for a
specified compute node within the Oracle Private Cloud Appliance.
Caution:
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-name [OPTIONS]where node-name 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 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 4-56 for more information.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
compute-node
|
The command target to perform the reprovision operation against. |
--save-local-repo
|
Skip the HMP step in the provisioning process in order to save the local storage repository. |
--json
|
Return the output of the command in JSON format. |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--force
|
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. |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-51 Reprovisioning a Compute Node
Caution:
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
rerun
Triggers a configuration task to re-run on the Oracle Private Cloud Appliance.
Syntax
rerun config-task id [OPTIONS] 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 4-44 for more information.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
config-task
|
The command target to perform the rerun operation against. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-52 Re-run a configuration task
PCA> rerun config-task 84 Status: Success
set system-property
Sets the value for a system property on the Oracle Private Cloud Appliance.
Syntax
set system-property property-name value [OPTIONS]where property-name is the system property you want to change, and 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.
Important:
The set system-property command only affects the settings for the
management node where it is run. If you use this command to change a setting on the active
management node, you should connect to the passive management node and run the equivalent
command there as well, to keep the two management nodes 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 4-56 for more information.
Important:
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. See the table in
"Options" for exceptions.
Options
The following table shows the available options for this command.
| Option | Description |
|---|---|
ftp_proxy
|
Set the value for the IP address of an FTP Proxy |
http_proxy
|
Set the value for the IP address of an HTTP Proxy |
https_proxy
|
Set the value for the IP address of an HTTPS Proxy |
log_count
|
Set the value for the number of log files that should be retained through log rotation |
log_file
|
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. |
log_level
|
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. |
log_size
|
Set the value for the maximum log size before a log is rotated |
phonehome
|
Set the state for the phone home service on the management nodes. The accepted values are: enable, disable. This command must be executed on both the active and passive management nodes. This command only enables the phone home flag on the management nodes. See Phone Home Service for information about additional required configuration. This command does not require you to restart the This option is available starting with software release 2.4.4.1. |
timezone
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-53 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
Note:
Log configuration through the CLI is described in more detail in Setting the Oracle Private Cloud Appliance Logging Parameters.
Example 4-54 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
Note:
Proxy configuration through the CLI is described in more detail in Adding Proxy Settings for Oracle Private Cloud Appliance Updates.
Example 4-55 Configuring the Oracle Private Cloud Appliance Time Zone
PCA> set system-property timezone US/Eastern Status: Success
show
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 object [OPTIONS] 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 Name |
|
|
iSCSI LUN Name |
|
|
Storage Profile Name |
|
|
Network Name |
|
|
NFS Share Name |
|
|
NFS Storage Profile Name |
|
|
Oracle Cloud Infrastructure Backup Name |
|
|
Oracle Cloud Infrastructure Target Name |
|
|
Rack Architecture or Type |
|
|
(none) |
|
|
Storage Network/Cloud Name |
|
|
(none) |
|
|
Task ID |
|
|
Tenant Group Name |
|
|
(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 |
|---|---|
show { cloud-wwpn | compute-node | iscsi-storage | iscsi-storage-profile |
network | nfs-storage | nfs-storage-profile | oci-backup | oci-target | rack-layout
| rack-type | storage-network | system-properties | task | tenant-group | version }
object [ --json ] [ --less ] [ --more ] [ --tee=OUTPUTFILENAME ]
|
The command target to show information for. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-56 Show System Properties
Note:
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 4-57 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 4-58 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 4-59 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 4-60 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: Success
Example 4-61 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: Success
Example 4-62 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 4-63 Show Oracle Private Cloud Appliance Version Information
PCA> show version ---------------------------------------- Version 2.4.1 Build 819 Date 2019-06-20 ---------------------------------------- Status: Success
start
Starts up a rack component.
Caution:
The start command is deprecated. It will be removed in the next release
of the Oracle Private Cloud Appliance Controller Software.
Syntax
start compute-node CN|management-node MN [OPTIONS] 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 |
|---|---|
compute-node CN | management-node MN
|
Start either a compute node or a management node. Replace CN or MN respectively with the host name of the server to be started. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-64 Starting a Compute Node
PCA> start compute-node ovcacn11r1 Status: Success
stop
Shuts down a rack component or aborts a running task.
Caution:
The stop commands to shut down rack components are deprecated. It will be
removed in the next release of the Oracle Private Cloud Appliance Controller Software.
The other stop commands, to abort tasks, remain functional.
Syntax
stop { compute-node CN | management-node MN | task id | update-task id } [OPTIONS] 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 |
|---|---|
compute-node CN | management-node MN
|
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. Caution: These options are deprecated. |
task id | update-task id
|
Aborts a running task. Use the Caution: Stopping an update task is a risky operation and should be used with extreme caution. |
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-65 Aborting a Task
PCA> stop task 341d45b5424c16 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success
update appliance
This command is deprecated. Its functionality is part of the Oracle Private Cloud Appliance Upgrader.
Caution:
Release 2.4.1 is for factory installation only. It cannot be used for field updates or upgrade operations on existing appliance environments.
update password
Modifies the password for one or more components within the Oracle Private Cloud Appliance.
Syntax
update password component PCA-password target-password [OPTIONS] where component is the name of the component you are changing the password, and 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.
Caution:
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 |
|---|---|
LeafSwitch-admin
|
Sets a new password for the |
MgmtNetSwitch-admin
|
Sets a new password for the |
SpineSwitch-admin
|
Sets a new password for the |
mgmt-root
|
Sets a new password for the |
mysql-appfw
|
Sets a new password for the The |
mysql-ovs
|
Sets a new password for the The |
mysql-root
|
Sets a new password for the The |
ovm-admin
|
Sets a new password for the |
spCn-root
|
Sets a new password for the |
spMn-root
|
Sets a new password for the |
spZfs-root
|
Sets a new password for the |
system-root
|
Sets a new password for the |
wls-weblogic
|
Sets a new password for the The |
zfs-root
|
Sets a new password for the |
--confirm
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-66 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
update compute-node
As of release 2.4.4, this command is no longer supported for compute node upgrade. Compute node upgrade functionality is now a part of the Oracle Private Cloud Appliance Upgrader.
Updates the Oracle Private Cloud Appliance compute nodes to the Oracle VM Server version included in the Oracle Private Cloud Appliance ISO image.
Syntax
update compute-node node [OPTIONS] where node is the identifier of the compute node that must be updated with the Oracle VM Server version provided as part of the appliance software ISO image. Run this command for one compute node at a time.
Attention:
Running the update compute-node command
with multiple node arguments is not
supported. Neither is running the command concurrently in
separate terminal windows.
Description
Use the update compute-node command to
install the new Oracle VM Server version on the selected compute
node or compute nodes. 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
|
Confirm flag for destructive command. Use this flag to disable the confirmation prompt when you run this command. |
--force
|
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. |
--json
|
Return the output of the command in JSON format |
--less
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--more
|
Return the output of the command one screen at a time for easy viewing, as with
the |
--tee=OUTPUTFILENAME
|
When returning the output of the command, also write it to the specified output file. |
Examples
Example 4-67 Upgrade a Compute Node to Oracle VM Server Release 4.2.x
PCA> update compute-node ovcacn10r1 ************************************************************ WARNING !!! THIS IS A DESTRUCTIVE OPERATION. ************************************************************ Are you sure [y/N]:y Status: Success