Oracle® Enterprise Manager Ops Center

Command Line Interface Guide

12c Release 2 (12.2.2.0.0)

E50492-04

February 2015

Oracle Enterprise Manager Ops Center Command Line Interface Guide, 12c Release 2 (12.2.2.0.0)

E50492-04

Copyright © 2007, 2015, Oracle and/or its affiliates. All rights reserved.

Primary Author: Salvador Esparza Perez, Barbara Higgins, Karen Orozco

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

1  Command Line Interface

- 1.1 CLI Features

- 1.1.1 Asset Discovery, Management, and Grouping

- 1.1.2 Operating System Provisioning and Patching

- 1.1.3 Firmware Provisioning

- 1.1.4 Administration

- 1.2 Starting the CLI

- 1.2.1 Invoking the Command Line Interface

- 1.2.2 Connecting From the Enterprise Controller

- 1.2.3 Connecting From a Remote System

- 1.2.4 Using the CLI

- 1.2.5 Defining User Variables

- 1.2.6 Using the CLI One-Liner

- 1.3 General Commands

- 1.3.1 Checking Connectivity

- 1.3.2 Displaying User Configuration

- 1.3.3 Setting the User Environment

- 1.3.4 Recording Console Input and Output

- 1.3.5 Using a Source File

- 1.3.6 Viewing the Version

- 1.3.7 Waiting for a Job to Complete

- 1.3.8 Viewing Help

- 1.3.9 Reviewing Commands

- 1.3.10 Displaying a Man Page

- 1.3.11 Ending a Mode

- 1.3.12 Disconnecting from Oracle Enterprise Manager Ops Center

- 1.3.13 Exiting the CLI

- 1.4 Universal Output Filters

- 1.5 Command Scripts

- 1.6 Mode Commands

- 1.6.1 Certificates

- 1.6.1.1 Viewing Certificates

- 1.6.1.2 Adding Certificates

- 1.6.1.3 Deleting Certificates

- 1.6.2 Collisions

- 1.6.2.1 Viewing host IDs or MAC address collisions for managed logical domains

- 1.6.2.2 Verifying collisions using a file containing logical domains data

- 1.6.2.3 Verifying collisions using specific host IDs or MAC addresses

- 1.6.2.4 Reserving MAC addresses from a network range

- 1.6.3 Controllers

- 1.6.3.1 Viewing Controllers

- 1.6.3.2 Evacuating Assets From a Failed Proxy Controller

- 1.6.4 Credentials

- 1.6.4.1 Viewing Credentials

- 1.6.4.2 Modifying Credential Details

- 1.6.5 Deploy-Setup

- 1.6.5.1 Starting Deploy-Setup Mode

- 1.6.5.2 Selecting a Deployment Plan

- 1.6.5.3 Selecting a Target Asset

- 1.6.6 Deploy

- 1.6.6.1 Viewing the Plan

- 1.6.6.2 Setting the Attributes of a Deployment Plan

- 1.6.6.3 Adding Attributes to a Deployment Plan

- 1.6.6.4 Testing a Deployment Plan

- 1.6.6.5 Applying a Deployment Plan

- 1.6.7 Discover

- 1.6.7.1 Starting Discover Mode

- 1.6.7.2 Creating a Discovery Job

- 1.6.7.3 Discovering an OS

- 1.6.7.4 Discovering an ILOM Service Processor

- 1.6.7.5 Discovering an ALOM Service Processor

- 1.6.7.6 Viewing Discovery Profiles

- 1.6.7.7 Viewing Discovery Ranges

- 1.6.7.8 Viewing Driver Credentials

- 1.6.7.9 Viewing Discovery Profile Credentials

- 1.6.7.10 Viewing Discovery Ranges

- 1.6.7.11 Viewing Networks

- 1.6.7.12 Executing Discovery Profiles

- 1.6.8 FWImage

- 1.6.8.1 Starting Fwimage Mode

- 1.6.8.2 Viewing Firmware Images

- 1.6.8.3 Creating a Firmware Image

- 1.6.8.4 Updating a Firmware Image

- 1.6.8.5 Deleting a Firmware Image

- 1.6.9 FWProfile

- 1.6.9.1 Starting FW Profile Mode

- 1.6.9.2 Viewing Firmware Profiles

- 1.6.9.3 Checking the Status of a Firmware Profile

- 1.6.9.4 Creating a Firmware Profile

- 1.6.9.5 Updating a Firmware Profile

- 1.6.9.6 Deleting a Firmware Profile

- 1.6.10 Gear

- 1.6.10.1 Starting Gear Mode

- 1.6.10.2 Viewing Assets

- 1.6.10.3 Updating Asset Information

- 1.6.10.4 Viewing Jobs Associated With Assets

- 1.6.10.5 Managing an Asset

- 1.6.10.6 Unmanaging an Asset

- 1.6.10.7 Setting the Maintenance Mode of an Asset

- 1.6.10.8 Deleting an Asset

- 1.6.10.9 Reinstalling an Agent Controller on an Operating System

- 1.6.10.10 Rebooting an Operating System

- 1.6.10.11 Updating Firmware

- 1.6.10.12 Checking Firmware Compliance

- 1.6.10.13 Provisioning an OS

- 1.6.10.14 Changing Locator Lights

- 1.6.10.15 Enabling or Disabling Notifications

- 1.6.10.16 Powering Off a Server or Chassis

- 1.6.10.17 Powering On a Server or Chassis

- 1.6.10.18 Resetting a Server or Chassis

- 1.6.10.19 Refreshing a Server

- 1.6.11 Groups

- 1.6.11.1 Starting Groups Mode

- 1.6.11.2 Viewing Groups

- 1.6.11.3 Viewing Members of a Group

- 1.6.11.4 Viewing Group Memberships

- 1.6.11.5 Creating a Group

- 1.6.11.6 Updating Group Attributes

- 1.6.11.7 Adding an Asset to a Group

- 1.6.11.8 Removing an Asset From a Group

- 1.6.11.9 Moving an Asset From One Group To Another Group

- 1.6.11.10 Deleting a Group

- 1.6.11.11 Powering on the Assets in a Group

- 1.6.11.12 Powering off the Assets in a Group

- 1.6.11.13 Resetting Servers in a Group

- 1.6.12 Incidents

- 1.6.12.1 Starting Incidents Mode

- 1.6.12.2 Viewing Incidents

- 1.6.12.3 Viewing Incident Details

- 1.6.12.4 Viewing Alerts Associated with Incidents

- 1.6.12.5 Acknowledging an Incident

- 1.6.12.6 Adding an Annotation to one or More Incidents

- 1.6.12.7 Assigning Incidents

- 1.6.12.8 Closing Incident

- 1.6.13 Jobs

- 1.6.13.1 Starting Jobs Mode

- 1.6.13.2 Viewing Jobs

- 1.6.13.3 Starting a Job

- 1.6.13.4 Repeating a Job on Failed Targets

- 1.6.13.5 Deleting a Job

- 1.6.13.6 Stopping a Job

- 1.6.14 Monitoring

- 1.6.14.1 Starting Monitoring Mode

- 1.6.14.2 List the monitoring state

- 1.6.14.3 Enabling monitoring

- 1.6.14.4 Disabling monitoring

- 1.6.15 Networks

- 1.6.15.1 Starting Networks Mode

- 1.6.15.2 Viewing the List of Managed Networks

- 1.6.16 Notifications

- 1.6.16.1 Starting Notifications Mode

- 1.6.16.2 Viewing Notifications

- 1.6.16.3 Deleting a Notification

- 1.6.17 OSImage

- 1.6.17.1 Starting OS Image Mode

- 1.6.17.2 Viewing OS Images

- 1.6.17.3 Importing an OS Image

- 1.6.17.4 Deleting an OS Image

- 1.6.18 OSProfile

- 1.6.18.1 Starting OS Profile Mode

- 1.6.18.2 Viewing OS Profiles

- 1.6.18.3 Importing a JET Template

- 1.6.18.4 Importing an OS Profile

- 1.6.18.5 Exporting an OS Profile

- 1.6.18.6 Copying an OS Profile

- 1.6.18.7 Deleting an OS Profile

- 1.6.19 Reports

- 1.6.19.1 Starting Reports Mode

- 1.6.19.2 Checking the Status of the Reporting Service

- 1.6.19.3 Starting the Reporting Service

- 1.6.19.4 Stopping the Reporting Service

- 1.6.19.5 Viewing Partitions

- 1.6.19.6 Viewing Detailed Partition Information

- 1.6.19.7 Viewing Assets Associated to a Partition

- 1.6.19.8 Checking Partitions

- 1.6.19.9 Converting Partition Samples to a new Format

- 1.6.19.10 Purging old Format Partition Samples

- 1.6.19.11 Enabling Automatic Rollup and Cleanup

- 1.6.19.12 Disabling Automatic Rollup and Cleanup

- 1.6.19.13 Starting Manual Rollup

- 1.6.19.14 Starting Manual Cleanup

- 1.6.19.15 Viewing Detailed Rollup and Cleanup Information

- 1.6.19.16 Viewing Rollup and Cleanup Statistics

- 1.6.19.17 Resetting Rollup Statistics

- 1.6.19.18 Setting the Pause Time

- 1.6.19.19 Resetting a Partition

- 1.6.19.20 Deleting a Partition

- 1.6.20 ServerPools

- 1.6.20.1 Starting Serverpools Mode

- 1.6.20.2 Viewing Server Pools

- 1.6.20.3 Viewing Members of a Server Pool

- 1.6.20.4 Removing a Member From a Server Pool

- 1.6.21 Stats

- 1.6.21.1 Starting Stats Mode

- 1.6.21.2 Viewing Statistics

- 1.6.22 Update

- 1.6.22.1 Starting Update Mode

- 1.6.22.2 Viewing OS Update Policies

- 1.6.22.3 Viewing OS Update Profiles

- 1.6.22.4 Viewing OS Distributions

- 1.6.22.5 Viewing Snapshots

- 1.6.22.6 Searching Inventory

- 1.6.22.7 Checking Inventory

- 1.6.22.8 Checking Connectivity to the Knowledge Base

- 1.6.22.9 Querying Job History

- 1.6.22.10 Querying Job Status

- 1.6.22.11 Uploading a Knowledge Base Bundle

- 1.6.22.12 Checking the Connection Mode

- 1.6.22.13 Changing to Connected Mode

- 1.6.22.14 Changing to Disconnected Mode

- 1.6.22.15 Modifying an OS Asset

- 1.6.22.16 Applying an Update Profile to an OS Asset

- 1.6.22.17 Creating a Historical Snapshot

- 1.6.22.18 Deleting a Snapshot

- 1.6.22.19 Creating a Profile

- 1.6.22.20 Creating a Profile From Inventory

- 1.6.22.21 Deleting a Profile

- 1.6.22.22 Adding a File to a Distribution

- 1.6.22.23 Uploading Local Software in Bulk From a Directory

- 1.6.22.24 Adding a Local Action

- 1.6.22.25 Adding a Local Category

- 1.6.22.26 Deleting a Component

- 1.6.22.27 Adding a Configuration File

- 1.6.22.28 Setting a Component File

- 1.6.22.29 Finding Nodes

- 1.6.23 User

- 1.6.23.1 Starting User Mode

- 1.6.23.2 Viewing Users

- 1.6.23.3 Viewing Role Types

- 1.6.23.4 Viewing User Roles

- 1.6.23.5 Adding a User to the Enterprise Controller

- 1.6.23.6 Granting Roles to a User

- 1.6.23.7 Replicating User Roles

- 1.6.23.8 Removing Roles From a User

- 1.6.23.9 Adding a Directory Server

- 1.6.23.10 Viewing Directory Servers

- 1.6.23.11 Viewing Remote Users

- 1.6.23.12 Synchronizing All Remote Users

- 1.6.23.13 Synchronizing a Single User

- 1.6.23.14 Removing a Directory Server

- 1.6.23.15 Deleting a User

- 1.6.24 Virtualization

- 1.6.24.1 Starting Virtualization Mode

- 1.6.24.2 Viewing Hosts

- 1.6.24.3 Viewing Guests

- 1.6.24.4 Migrating a Non-Global Zone

- 1.6.25 Finding the Equivalent Browser User Interface Actions For the Mode Commands

- 1.6.25.1 Controllers Mode

- 1.6.25.2 Credentials Mode

- 1.6.25.3 Deploy-Setup Mode

- 1.6.25.4 Deploy Mode

- 1.6.25.5 Discover Mode

- 1.6.25.6 FWImage Mode

- 1.6.25.7 FWProfile Mode

- 1.6.25.8 Gear Mode

- 1.6.25.9 Groups Mode

- 1.6.25.10 Incidents Mode

- 1.6.25.11 Jobs Mode

- 1.6.25.12 Notifications Mode

- 1.6.25.13 OSImage Mode

- 1.6.25.14 OSProfile Mode

- 1.6.25.15 Reports Mode

- 1.6.25.16 ServerPools Mode

- 1.6.25.17 Update Mode

- 1.6.25.18 User Mode

- 1.6.25.19 Virtualization Mode

2 Man Pages for Enterprise Manager Ops Center

- oc

- certificates

- collisions

- controllers

- credentials

- deploy

- deploy-setup

- discover

- fwimage

- fwprofile

- gear

- groups

- incidents

- jobs

- monitoring

- networks

- notifications

- osimage

- osprofile

- reports

- serverpools

- stats

- update

- user

- virtualization

Index

Preface

The Oracle® Enterprise Manager Ops Center Command Line Interface Guide describes the commands usage for the Oracle Enterprise Manager Ops Center command-line interface.

Audience

This document is intended for users who require a detailed description of the functionality of the command-line interface. The reader should already be familiar with Oracle Enterprise Manager Ops Center.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

For more information, see the Oracle Enterprise Manager Ops Center Documentation Library at http://docs.oracle.com/cd/E40871_01/index.htm.

Oracle Enterprise Manager Ops Center provides online Help. Click Help at the top-right corner of any page in the user interface to display the online help window.

For the latest releases of Oracle documentation, check the Oracle Technology Network at: http://www.oracle.com/technetwork/documentation/index.html#em.

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1  Command Line Interface

The Oracle Enterprise Manager Ops Center Command Line Interface (CLI) is an alternative to the browser user interface for Oracle Enterprise Manager Ops Center.

This chapter explains how to use the Oracle Enterprise Ops Center CLI and all the commands included within this tool.

The following information is included:

- CLI Features

- Starting the CLI

- General Commands

- Universal Output Filters

- Command Scripts

- Mode Commands

1.1 CLI Features

The Oracle Enterprise Manager Ops Center CLI can perform many, but not all, functions of Oracle Enterprise Manager Ops Center. The following charts show the available features.

1.1.1 Asset Discovery, Management, and Grouping

Table 1-1 shows the functions that the CLI can perform for asset discovery, management, and grouping.

Table 1-1 Asset Discovery, Management, and Grouping

Function

Possible with CLI

Mode

Find asset

Yes

Discover

Execute discovery profiles

Yes

Discover

Add asset

No

n/a

Declare asset

No

n/a

Manage asset

Yes

Gear

Unmanage asset

Yes

Gear

Register asset

Yes

Gear

View asset data

Yes

Gear

Update asset data

Yes

Gear

Reset a server

Yes

Gear

Refresh a server

Yes

Gear

Manage locator lights

Yes

Gear

Manage power settings

Yes

Gear

Reboot an OS

Yes

Gear

Reinstall an asset on an OS

Yes

Gear

Create a group

Yes

Groups

Add asset to a group

Yes

Groups

Move assets between groups

Yes

Group

Manage power settings of an asset in a group

Yes

Group

Delete a group

Yes

Group

Delete an asset

Yes

Gear

1.1.2 Operating System Provisioning and Patching

Table 1-2 shows the functions that the CLI can perform for operating system provisioning and patching.

Table 1-2 Operating System Provisioning and Patching

Function

Possible with CLI

Mode

Import an OS image

Yes

OSImage

Delete an OS image

Yes

OSImage

Create an OS profile

No

n/a

Import an OS profile

Yes

OSProfile

Export an OS profile

Yes

OSProfile

Clone an OS profile

Yes

OSProfile

Delete an OS profile

Yes

OSProfile

Import a JET template

Yes

OSProfile

Provision an OS

Yes

Gear

Check inventory

Yes

Update

Upload a knowledge base bundle

Yes

Update

Update operating systems

Yes

Update

Create OS update profiles

Yes

Update

Apply OS update profiles

Yes

Update

Add a configuration file

Yes

Update

Add a file to a distribution

Yes

Update

Run OS update profiles

No

n/a

1.1.3 Firmware Provisioning

Table 1-3 shows the functions that the CLI can perform for firmware provisioning.

Table 1-3 Firmware Provisioning

Function

Possible with CLI

Mode

Create a firmware image

Yes

FWImage

Update a firmware image

Yes

FWImage

Delete a firmware image

Yes

FWImage

Create a firmware profile

Yes

FWProfile

Update a firmware profile

Yes

FWProfile

Delete a firmware profile

Yes

FWProfile

Update firmware

Yes

Gear

Check firmware compliance

Yes

Gear

Run firmware reports

No

n/a

1.1.4 Administration

Table 1-4 shows the functions that the CLI can perform for administration.

Table 1-4 Administration

Function

Possible with CLI

Mode

Change connection mode

Yes

Update

Deploy a Proxy Controller

No

n/a

Manage users and roles

Yes

User

View roles

Yes

Jobs

Manage jobs

Yes

Jobs

View notifications

Yes

Notifications

Delete notifications

Yes

Notifications

Manage incidents

Yes

Incidents

1.2 Starting the CLI

The CLI must share information with the Enterprise Controller, therefore you must connect the CLI to the Enterprise Controller.

When the CLI runs on a system other than the Enterprise Controller, the system's credentials are necessary to connect to the Enterprise Controller. When the CLI runs on the same system as the Enterprise Controller, the CLI does not need credentials.

1.2.1 Invoking the Command Line Interface

You get access to the command line interface from the following locations:

- Oracle Solaris: /opt/SUNWoccli/bin

- Linux: /opt/sun/occli/bin

You must have Java SE Development Kit (JDK) 6 or 7 installed in the system running the CLI.

1.2.2 Connecting From the Enterprise Controller

1. Enter the oc command.

# ./oc
xvmSh>

You can also add some options. For more information about the options for the oc command, see Using the CLI.

2. Enter the connect command.

xvmSh > connect

localhost >

The CLI is connected to the Enterprise Controller.

1.2.3 Connecting From a Remote System

When connecting from a remote system, the CLI verifies that the certificate of the EC server is in the list of trusted certificates. For new connections or after reinstalling your EC, you must accept the server's certificates to establish the connection. Once accepted, the certificates are stored in a local trust store for the user and do not require acceptance again. For more information about certificates, see Certificates.

1. Enter the oc command.

# ./oc
xvmSh>

You can also add some options. For more information about the options for the oc command, see Using the CLI.

2. Enter the connect command with the -h <enterprise controller>, -u <user name>, and -p <password>| -p@<filename for password> options.

Note:
If you do not use the -h, -u, and -p options, you are prompted for the Enterprise Controller name, user name, and password.

Note:
You might receive a message to accept or deny the addition of the EC server certificate to the trusted list.

Use the -a| --accept-all-certificcates option to accept all certificates without receiving any confirmation message.

Examples:

xvmSh > connect -h EnterpriseController -u root -p rootpass

EnterpriseController >

xvmSh > connect -h EnterpriseController -u root -p@/tmp/pwd
EnterpriseController >

The CLI is connected to the Enterprise Controller.

Note:
If you do not use the -h, -u, and -p options, you are prompted for the Enterprise Controller name, user name, and password.

1.2.4 Using the CLI

The CLI is accessed with the oc command. The oc command can be run with the following options:

- Use -V| --version to show the CLI version and exit.

- Use -h| --help to show the CLI help and exit.

- Use -q| --quiet to be as quiet as possible.

- Use -d| --debug <debug level> to specify a debug logging level. Debug logging levels are DEBUG, FINEDEBUG, CMDSTAT, INFO, WARNING, ERROR, CRITICAL, OFF, and ALL.

- Use -c| --cmdfile <file> to execute the <file> command file.

- Use -e| --eval <command> for one-line execution. The <command> command is the only command to be executed. This option can be run with one-liners. For more information about one-liners see Using the CLI One-Liner.

- Use -o| --outfile <file> to write the output to the <file> file.

- Use -O|--output_format <format> to specify an output format. Format can be text of parsable.

Examples:

#./oc -V
OpsCenter Command Line Interface 12.1.0

#./oc -e history
495 connect
496 version

1.2.5 Defining User Variables

Variables can be defined and then used within any command.

To define a user variable, enter set <variable name>=<value> in the command prompt.

Example:

#./oc
xvmSh> set JOBID=foo.3
xvmSh> connect
localhost> jobs.list -x $JOBID

1.2.6 Using the CLI One-Liner

The CLI accepts a list of commands as an argument.

To use the CLI one-liner, enter ./oc -e 'list commands separated by a semicolon'in the command prompt.

Example:

#./oc -e 'connect ; jobs.list | grep FAILED'

1.3 General Commands

The following are general commands used either for CLI execution or as universal commands.

Note:
You can use the Tab key to see a list of the available commands or as a completion key when typing a command.

1.3.1 Checking Connectivity

The ping command checks connectivity to the Enterprise Controller.

To check the connectivity to the Enterprise Controller, enter ping in the command prompt.

Example:

localhost > ping
OEMEC None is alive, version : 12.1.0.1848

1.3.2 Displaying User Configuration

The printenv command displays the current user configuration. The variables included in the user configuration are:

- Output_format: Format for the command output.

- Parsable_text_separator: Text separator for parsable command output.

- Log_level: Logging level.

- History_length: Number of commands saved in the history.

- Debug: Debug logging.

- Pager: Pager for long output.

- Continue_on_error: Continue when a command fails.

- Text_wrap_width: Maximum width, in characters, to be displayed in a line.

- Accept_all_certificates: Flag to enable or disable accepting all certificates by default.

To display the current user configuration, enter printenv in the command prompt.

Example:

localhost > printenv
output_format=textparsable_text_separator=log_level=OFFhistory_length=500debug=falsepager=falsecontinue_on_error=falsetext_wrap_width=-1
accept_all_certificates = false

The user configuration can be changed using the setenv command.

1.3.3 Setting the User Environment

The setenv command sets the user environment in the following ways:

output_format=text|parsable
parsable_text_separator=text
log_level=OFF|ON
history_length=integer
debug=true|false
pager=true|false
continue_on_error=true|false
text_wrap_width=integer
accept_all_certificates = true|false

To set the user environment, enter sentenv <variable>=<value> in the command prompt.

Example:

localhost > setenv pager=true

Note:
You must set the pager variable to true before running some commands, such as the man command.

1.3.4 Recording Console Input and Output

The record command copies all console inputs and outputs to a text file. You can save the resulting file in the directory you prefer. Issue the command without a file name to stop the recording.

To record the console inputs and outputs into a text file, enter record <filename> in the command prompt.

Example:

localhost > record foo.file

Note:
Use the Tab key for filename completion.

1.3.5 Using a Source File

The source command uses command script files to source commands as if they were entered at the prompt. For more information about command scripts, see Command Scripts. This command is also used to specify a file as the source of an operation when executing other commands. This file can be used for information that is shared by more than one script, or to keep secure information separate.

To use a source file, enter source <filename> in the command prompt.

Example:

EnterpriseControler > source /tmp/cmds

1.3.6 Viewing the Version

The version command displays the version of the CLI, the Oracle Enterprise Manager Ops Center software, the Java SE Runtime Environment, and the Java HotSpot Server VM software.

To view the version of the CLI, enter version in the command prompt.

Example:

localhost > version
CLI version: 12.1.0OpsCenter version: 12.1.0.1848Platform: Java-1.6.0_21-Java_HotSpot-TM-_Server_VM,_17.0-b16,_Sun_Microsystems_Inc.-on-SunOS-5.10-x86Jython Version: 2.5.1

1.3.7 Waiting for a Job to Complete

You can set the CLI to wait until either the most recent job or a specific job finishes before launching a new job, using the wait command. This can be useful if one job, such as a discovery, is a requirement for another job, such as grouping or managing discovered assets. You can identify a job by its jobID or by its runID.

The wait command is used in command scripts where many commands are run almost at the same time, and a command must wait to be executed until the job launched by the previous command is completed. For more information about command scripts, see Command Scripts. This command can be used from within any mode at any time or from the main command line.

To wait for a job to complete, enter wait in the command prompt.

Use the -i| --jobid <job ID> option to specify a job ID. The CLI waits for that job to complete.

Use the -r| --runid <run ID> option to specify a job runID. The CLI waits for that job to complete. Default is to wait for the last job.

Use the -a| --all option to wait for all jobs.

Use the -n| --maxwait <maximum wait time> to specify a timeout, a maximum number of seconds to wait for a job to complete.

Note:
To interrupt a wait operation during interactive session, press Ctrl+C.

1.3.8 Viewing Help

You can use the help command to show the available commands. This command can be used from within any mode at any time or from the main command line.

To show the available commands, enter help in the command prompt.

Use the -l option to include detailed usage information.

1.3.9 Reviewing Commands

The history command shows recent commands. This command can be used from within any mode at any time or from the main command line.

To show the recent commands, enter history in the command prompt.

Use the -n <number of commands> option to limit the history list.

Example:

localhost > history -n 3

The history includes a command number for the sequence. To repeat a command in the history enter the ! character with the command number and press the Tab key, as shown in the following example:

localhost > history -n 3
495 connect
496 version
498 history -n 3
#!496 <TAB>
#version

1.3.10 Displaying a Man Page

You can display the man page for a specific mode, using the man command. The syntax usage and description for all mode subcommands are included in the man page. This command can be used from within any mode at any time or from the main command line.

To display the man page for a specific mode, enter man <mode name> in the command prompt.

Example:

localhost > man gear

If no mode name is given, the CLI man page is displayed.

To see a list of man pages, enter the command and press the Tab key.

Note:
The man command requires the pager environment variable to be set to true for multipage output before being run. For more information about how to set the pager variable to true, see Setting the User Environment.

1.3.11 Ending a Mode

You can exit a mode and return to the initial CLI prompt, using the end command. This command can be used from within any mode at any time or from the main command line.

To exit a mode, enter end in the command prompt.

Example:

localhost/gear > end
localhost >

1.3.12 Disconnecting from Oracle Enterprise Manager Ops Center

The disconnect command closes the connection between the Oracle Enterprise Manager Ops Center Command Line Interface and the Enterprise Controller.

To disconnect from the Enterprise Controller, enter disconnect in the command prompt.

Example:

localhost > disconnect
xvmSh >

1.3.13 Exiting the CLI

You can exit the CLI from any mode, using the exit command. This command can be used from within any mode at any time or from the main command line.

To exit the CLI, enter exit in the command prompt.

Example:

localhost > exit
#

1.4 Universal Output Filters

For any main or mode command, you can constrain the output by appending one of the following filters to the command:

- |grep regexp to filter by the regular expression

- |count integer to display only the number of output lines

- |tee filename to write the output to a file

Example:

localhost/jobs > list | tee /var/tmp/todays_jobs.txt

Note:
For better results with grep and count filters, activate parsable output, using the setenv command.

1.5 Command Scripts

The CLI can also be used in a non-interactive way, using command scripts. The following example shows a script named update.xvm that writes the inventory of a server to a file:

connect finance_svr -u zz3282134 -p b@seba11
update
csv_inventory -h finance_svr -f ~/inventory_latest.csv
wait
end

To create the file at any time, issue the following command:

oc --cmdfile update.xvm

To run a command script use the source command.

Example:

xvmSh > source update.xvm

1.6 Mode Commands

The commands in this section start a mode that includes a set of subcommands. Use the man command to display the man page for each mode.

- Certificates – Use certificates mode to view and manage trusted certificates.

- Collisions – Use collisions mode to detect collisions of host IDs or MAC addresses used by logical domains.

- Controllers – Use controllers mode to migrate assets from one Proxy Controller to another Proxy Controller.

- Credentials – Use credentials mode to view and manage driver credentials.

- Deploy-Setup – Use deploy-setup mode to set up the plan and target to deploy an asset.

- Deploy – Use deploy mode to deploy an asset.

- Discover – Use discovery mode to discover gear (assets).

- FWImage – Use fwimage mode to create, view, and manage firmware images.

- FWProfile – Use fwprofile mode to create, view, and manage firmware profiles.

- Gear – Use gear mode to view and manage gear (assets) and provision operating systems and firmware.

- Groups – Use groups mode to view, create, and manage groups.

- Incidents – Use incidents mode to view and manage incidents.

- Jobs – Use jobs mode to view and manage jobs.

- Monitoring – Use monitoring mode to manage monitoring services.

- Networks – Use networks mode to display the list of managed networks.

- Notifications – Use notifications mode to view notifications and change notification settings.

- OSImage – Use osimage mode to view, manage, and install OS images.

- OSProfile – Use opsrofile mode to view, manage, and import OS profiles.

- Reports – Use reports mode to manage the reporting service.

- ServerPools – Use serverpools mode to view, and manage server pools.

- Stats – Use stats mode to view statistics about the Enterprise Controller.

- Update – Use update mode to view and manage OS update profiles, policies, snapshots, and distributions, and view and change the connection mode.

- User – Use user mode to create, view and manage users and roles.

- Virtualization – Use virtualization mode to view, and manage virtual hosts and virtual machines.

Unlike the ecadm and proxyadm commands, which are used for administering the Enterprise Controller and its Proxy Controllers, the CLI operates on the assets of the data center.

To execute a subcommand within a mode:

- Enter the mode, then enter the subcommand.

- Enter <mode name>.<subcommand name>.
Example:

localhost > jobs.list

For information about the mode commands that have a corresponding action in the browser user interface, see Finding the Equivalent Browser User Interface Actions For the Mode Commands.

1.6.1 Certificates

Certificates mode allows you to view and manage the list of trusted certificates for known remote EC servers. The CLI doesn't check for certificates in local connections.

Certificates are stored in a truststore file in the user directory. When connecting to an EC remotely, the CLI verifies if the certificate chain of the EC server is part of the trusted list. If the certificate chain is not in the trusted list, then the CLI request to accept the new certificate to add it to the list. If the certificate chain is not accepted, then the connection fails.

Additionally, you can set your user environment to silently accept all certificates by setting the accept_all_certificates variable to true, see Setting the User Environment for more information in changing the value of the variable. You can also set your connection to silently accept all certificates by using the -a or --accept_all_certificates option with the connect command. This is especially useful for non-interactive sessions where it is not possible to interactively accept the certificate.

To enable your scripts to connect to a remote server, you can choose from the following options:

- If you reinstall your EC and CLI often, modify your scripts to add the -a or --accept_all_certificates option to the connect command to make them pass-through.

- If you reinstall your EC often but not the CLI, you might prefer to change the new CLI preference accept_all_certificates to automatically accept certificates at all times for all servers to which it connects. You can also add the following line at the beginning of each script to add the certificate, although this command connects to the EC and then disconnects: certificates.add -h hostname -u username [-n port] -p password -f.

- If you do not reinstall your EC often, then you can connect to the EC interactively to accept the certificate at the user level which adds it to the user's truststore. In this case you will need to connect interactively to it after each reinstall of your EC to accept its new certificates.

1.6.1.1 Viewing Certificates

You can view the list of existing trusted certificates.

- Enter list.

xvmSh/certificates > list

Alias        |            Issuer            |           Subject            | Serial Number |
---------------------------------------------------------------------------------------------------
root@sm-36:11172|    CN=sm-36_oem-ec_ca    |    CN=sm-36_oem-ec_ca    |   385822055
root@sm-36:11172|    CN=sm-36_oem-ec_ca    |  CN=sm-36_oem-ec_agent   |   1497938285

Use the -a| --alias <alias> option to list a specific alias or a list of aliases separated by a comma.

Use the -d| --detail option to include detailed certificate information.

1.6.1.2 Adding Certificates

You can add a certificate to the trusted list.

- Enter add -h| --hostname <EChostname> -u| --username <username>

xvmSh/certificates > add -h sm-37 -u root
Enter password for authentication > ********
Untrusted certificate encountered. Create an exception to accept it at each connection? [Display/Yes/No] y
Certificate chain added for root@sm-37:11172

Use the -p| --pass <password> option to add without entering the user password interactively.

Use the -f| -- force option to add without receiving any confirmation message, useful for scripts where no interaction is possible.

Use the -n| --port <port_number> option to add the port number to use.

1.6.1.3 Deleting Certificates

You can delete a certificate from the trusted list.

- Enter remove -a|--alias <alias>

xvmSh/certificates > remove -a root@sm-37:11172
xvmSh/certificates >

1.6.2 Collisions

This module is about detecting collisions of host IDs and MAC addresses used by logical domains managed by Oracle Enterprise Manager Ops Center. A collision is an occurrence of a duplicated host ID or MAC address used by two or more logical domains.

You can run this command to detect host ID or MAC address collisions of logical domains existing in the Enterprise Controller.

This command also allows you to detect if specific host IDs or MAC addresses collide with host IDs or MAC addresses used by logical domains inside the Enterprise Controller. This functionality is specially useful to prevent collisions before adding logical domains created outside of Enterprise Manager Ops Center. You can either provide a file containing data of the logical domains or provide the host IDs or MAC addresses as part of the command.

Additionally, you can reserve a number of MAC addresses from a specified range. You can use the reserved MAC addresses to assign them to a future logical domain to guarantee it will not collide with other MAC address used inside the Enterprise Controller.

1.6.2.1 Viewing host IDs or MAC address collisions for managed logical domains

You can list all collisions detected for all existing logical domains inside the Enterprise Controller. You can filter the list by type of collisions detected for host IDs or MAC addresses.

Enter list -t|--type <all|hostid|macaddres>

xvmSh/collisions > list -t hostid
Collision on hostid 84ffb4b4  :
server            |             name             |                  UUID                  |        MAC         |
----------------------------------------------------------------------------------
foo.example.com  |        ldom_guest        |  a2478fdd-62f8-c4af-afdd-e2d93cc93abb  | 00:14:4F:FB:5D:0E
foo.example.com  |         ldom_guest1          |  7db50419-d46d-4351-b7f7-ba7d5f1c76fd  | 00:14:4F:FF:B4:B4

1.6.2.2 Verifying collisions using a file containing logical domains data

You can verify if host IDs or MAC addresses collide with a host ID or MAC address used by logical domains inside the Enterprise Controller. You can specify the name of the file containing data of logical domains to check them for possible collisions.

Enter list -t|--type <all|hostid|macaddres> -f|--file <filename>

xvmSh/collisions > list -t hostid -f dumpldoms.txt
Collision on hostid 84ffb4b4  :
server            |             name             |                  UUID                  |        MAC         |
----------------------------------------------------------------------------------
foo.example.com  |        ldom_guest        |  a2478fdd-62f8-c4af-afdd-e2d93cc93abb  | 00:14:4F:FB:5D:0E
foo.example.com         |    guest-inter-collision     |  544fe468-90a8-66ce-990f-bb4b79842fa9  | 00:14:4F:FA:2D:E1

You can run the script /opt/sun/n1gc/bin/read_mac on Oracle VM for SPARC control domains to collect their logical domains data. You can send the output of the script to a file and then use that file as part of the -f|--file option.

1.6.2.3 Verifying collisions using specific host IDs or MAC addresses

You can verify if the specified host IDs or MAC addresses collide with a host ID or MAC address used by logical domains inside the Enterprise Controller. You can choose to filter the list by type of collisions for either host IDs or MAC addresses.

Verifies if the specified host IDs or MAC addresses collide with a host IDs or MAC addresses used by logical domains inside the Enterprise Controller. This command identifies different level of collisions:

- Severe – For host ID collisions between two or more logical domains.

- Warning – For MAC address collisions between two or more vnets of logical domains, including alternate MAC addresses of the vnets.

- Info – For MAC address collisions between vnets of logical domains and logical domain MAC addresses.

Enter check -t|--type <hostid|macaddres> -v|--value <values>

xvmSh/collisions > check -t macaddress -v 0:14:4F:FB:5D:0E,00:14:4F:FA:2D:E1
Collision Level - INFO :
server            |             name             |                  UUID                  |        MAC         |
----------------------------------------------------------------------------------
foo.example.com  |        ldom_guest        |  a2478fdd-62f8-c4af-afdd-e2d93cc93abb  | 00:14:4F:FB:5D:0E
foo.example.com  |    ldom_guest_2_collision    |  3c526eeb-f38c-c169-ed1c-88a0825e7a38  | 00:14:4F:FB:5D:0E

1.6.2.4 Reserving MAC addresses from a network range

You can reserve a number MAC addresses from a MAC address network range. You can reserve MAC addressed from the manual or automatic range.

Enter allocate -n|--size <number> -r|--range <manual|auto>

xvmSh/collisions > allocate -n 2 -r manual
Allocated MAC addresses:
MAC Address       |
--------------------------
00:14:4F:FD:5C:AD
00:14:4F:FF:05:E5

1.6.3 Controllers

Controllers mode allows you to evacuate the assets managed by a failed Proxy Controller to other available Proxy Controllers. This mode also allows you to view the available Proxy Controllers that you can use to evacuate the assets.

1.6.3.1 Viewing Controllers

You can view a list of the available Proxy Controllers, Enterprise Controllers, and Virtualization Controllers.

- Enter list.

localhost/controllers > list
Controller list:
Name        |                 UUID                 |Status |   Version   |
-----------------------------------------------------------------------------
192.0.2.95-PC     | abcd76fd-28be-abcd-8uae-abcd20b780e1 |UNKNOWN| 12.1.4.2311|
192.0.2.97-PC     | abcdcdab-7654-abcd-a781-abcd96791054 |   OK  | 12.1.4.2311|
192.0.297-EC      | abcd2f30-ef67-abcd-ab12-abcd9b6ab671 |   OK  | 12.1.4.2311|
x44-VC            | abcde955-1edt-abcd-adi5-abcdgg1e74e6 |   OK  | 12.1.4.2311|

1.6.3.2 Evacuating Assets From a Failed Proxy Controller

You can evacuate the assets managed by a failed Proxy Controller to other available Proxy Controllers. The Proxy Controller to which the assets can be migrated is automatically determined based on the networks managed by the remaining available Proxy Controllers and their load.

- Enter migrate_assets -U| --UUID <proxy_uuid>.

localhost/controllers > migrate_assets -U h4fm76fd-28be-4892-8uae-4i8b20b780e1

WARNING:

The failed Proxy Controller will be removed, and its MBeans will be unregistered after the job launched by this command is finished.

1.6.4 Credentials

Credentials mode allows you to view and manage the driver credentials necessary to discover and manage assets. The credentials also help to establish trust between internal components.

1.6.4.1 Viewing Credentials

You can view a list of existing driver credentials

- Enter list.

localhost/credentials > list
Driver Credentials:
ID  |      Name        |   Type   |       Description       |
--------------------------------------------------------------
6850 |     admin        |    SSH   |   root/admin SSH creds  |
6840 |   occosIPMI      |   IPMI   |          IPMI           |

Use the -i| --ids <credential IDs> option to give a specific credential ID or a list of credential IDs. IDs must be separated by a comma.

Use the -l| --detail option to include detailed credential information.

1.6.4.2 Modifying Credential Details

You can modify the values of a driver credential. The modify command starts a submode with its own set of subcommands.

1. Enter modify -i| --id <credential ID>.

localhost/credentials > modify -i 6840
localhost/credentials/modify >

2. (Optional) Use the show command to display the current properties of the credential.

localhost/credentials/modify > show
description=IPMI
*sharedSecret=*****
*login=IPMI_user
*name=occosIPMI

Note:
Properties marked with an asterisk (*) at the beginning must be set.

3. Enter set <property>=<value> to modify a property value of the credential.

localhost/credentials/modify > set name=IPMI_cred

4. If necessary, use the unset <property> command to unset a property or the reset command to reset all properties.

5. Use the commit command to apply the change.

1.6.5 Deploy-Setup

Deploy-setup mode allows you to specify a deployment plan and its target. The deployment plan must exist already and the asset must be already a managed asset.

1.6.5.1 Starting Deploy-Setup Mode

You must switch to deploy-setup mode to run commands for deploying assets. To start the deploy-setup mode, enter the deploy mode, which redirects you to the deploy-setup mode.

- Enter deploy in the CLI prompt.

localhost > deploy
localhost/deploy-setup >

1.6.5.2 Selecting a Deployment Plan

You must select an existing deployment plan.

- Enter plan <plan name>
Use the -v| --version option to specify a version of a plan.

localhost/deploy-setup > plan plan-fwp
Plan "plan-fwp" selected: version 1, description "None"

1.6.5.3 Selecting a Target Asset

You must select an asset as the target of the deployment plan. You must always indicate an asset name or public UUID. In case of ambiguity, where multiple assets have the same user friendly name, the user is informed to use UUID instead.

- Enter target <asset name or public UUID>
You can also add some other options:

Use the -a| --add option to add assets to current set of targets.

Use the -d| --delete option to delete assets from the current set of targets.

Use the -g| --gear <asset name> option to give an asset name or a list of asset names, separated by comma.

Use the -U| --UUID <public UUID> option to give an asset UUID or a list of asset UUIDs, separated by comma.

Example using an asset's friendly user name:

localhost/deploy-setup > target foo.example.com

Example using an asset public UUID:

localhost/deploy-setup > target 53f6e87f-3582-4cda-9c63-9121a3a8beb3

After you specify the plan and target, the mode changes from the deploy-setup mode to the deploy mode. This is reflected at the command prompt as follows:

localhost/deploy>

1.6.6 Deploy

Deploy mode allows you to deploy an asset.

1.6.6.1 Viewing the Plan

You can view the attributes of the deployment plan or the deployment plan structure.

To view the attributes of a deployment plan:

- Enter show plan.

localhost/deploy > show plan
Target: foo.example.com
__________________________________________________
Step: Update Firmware
__________________________________________________
Associated Profile:
{
firmwarePackages:
[
ILOM-3_0_3_31_a-Sun_Fire_X4600M2
]
dryRun: False
subType: Server
resetSP: False
profileDescription:
forceDowngrade: False
forceReinstall: False
profileName: fwp-profile
network: None
ip: None

}

To view the structure of a plan:

- Enter show.

localhost/deploy > show
Step: Update Firmware
__________________________________________________
{
isDryRun: Dry run?
type: boolean

firmwarePackages: Firmware Packages
type: array of [
type:java.lang.String
]

resetSP: Reset SP?
type: boolean

forceDowngrade: Force Downgrade?
type: boolean

forceReinstall: Force Reinstall?
type: boolean

ip: IP Address
type: java.lang.String

network: Network Information
{
gateway: Gateway IP Address
type: java.lang.String

objectName: Object Name
type: java.lang.String

userFriendlyName: User Friendly Name
type: java.lang.String

netmask: Network Address Mask
type: java.lang.String

ip: IP Address
type: java.lang.String

}
}

To view the results of a deployment plan:

- Enter show results.
Example:

localhost/deploy > show results
Step: Provision OS
Operating-System-1

1.6.6.2 Setting the Attributes of a Deployment Plan

You can modify the value of the attributes of a deployment plan using the set command. Some deployment plans require specific information during the deployment. See Table 1-5 for the names of the attributes you must set before applying the plan.

Table 1-5 Deployment Plans and Attributes

Deployment Plan

Attributes

Configure M-Series Hardware, Create and Install Domain

No per-target attribute collection required.

Configure RAID

No per-target attribute collection required.

Configure Server Hardware and Install OS

No per-target attribute collection required.

Configure Service Processor

No per-target attribute collection required.

Configure and Install Dynamic System Domain

No per-target attribute collection required.

Configure and Install Logical Domains

No per-target attribute collection required.

Configure and Install Virtual Machines

No per-target attribute collection required.

Create Boot Environment

No per-target attribute collection required.

Create Dynamic System Domain

No per-target attribute collection required.

Create Logical Domains

guestName: name of the new logical domain. This is just the name of the virtual server guest.

(Optional) prime: set to true to set the resource plan data so that the already set profile data on the logical domain step are used to prime the resource data.

Logical domains creation requires the setting of resource plan structures per each logical domain to create.

Create Solaris Zones

ipAddress: IP for the new zone, if mode is static.

ipMode: IP address assignment mode. Value = static or dynamic.

ifName: network interface name to identify NIC to assign to zone.

hostName: host name of the new zone.

(Optional) prime: set to true to set the resource plan data so that the already set profile data on the zone step are used to prime the resource data.

Solaris zones creation requires the setting of resource plan structures per each logical domain to create.

Configure and Install Solaris Zones

The only parameters that must be set are the same as those used in creating an Oracle Solaris zones deployment plan.

Create Virtual Machines

No per-target attribute collection required.

Provision Network

No per-target attribute collection required.

Provision OS

ip: set this attribute if networking option selected in the OS provision profile was None or Link Aggregation.

dataIp: set this attribute if networking option selected in the OS provision profile was IPMP.

Install Server

The only parameters that must be set are the same than in provision OS.

Software Deployment / Update

No per-target attribute collection required.

Update Solaris 11 OS

No per-target attribute collection required.

Update BIOS Configuration

No per-target attribute collection required.

Update Firmware

No per-target attribute collection required.

Update Firmware and Install Oracle VM Server for SPARC

No per-target attribute collection required.

Use the following syntax to set an attribute or list of attributes of a deployment plan:

- For simple types:
Enter set "<attribute-name> = <'string-value'>"|<int>|<true|false>

Examples:

localhost/deploy > set "forceReinstall = false"
localhost/deploy > set "ip = '192.0.2.23'"

- For attributes that are backed by other struct-like value objects, use the following syntax:
Enter set "<attribute-name> = list or nested object"

set "network={gateway='192.0.2.111', userFriendlyName='ip address', ip='192.0.2.4'}"

- If you use JavaScript Objet Notation (JSON) format, use the following syntax:

set "{'resourcePlans':[{'hostName':'myhostname','networks':[{'networkBindings':[{'ipAddress':'192.0.2.1'}]}]}]}"

Or

set "resourcePlans=[{hostName='myhostname',networks=[{networkBindings=[{ipAddress='192.0.2.1'}]}]}]"

Or

set "<json-string> "

- For deployment plans on multiple targets that require unique values for each target, use the set command as follows:

localhost/deploy > set "@<target-uuid or dynamic-target>:<key>=<'string-value'>"|<int>|<true|false>|list of nested objects"
set "<@target-uuid or dynamic-target>:<json-string>"

Example:

localhost/deploy > set @<target-UUID>:"network={gateway='192.0.2.1', userFriendlyName='ip address', ip='192.0.2.4'}"

1.6.6.3 Adding Attributes to a Deployment Plan

You can add attributes to a deployment plan using the add command. The syntax for adding attributes is similar to the syntax for setting attributes. However, for arrays, the add command appends an element to the array while the set command modifies the attribute of an existing element within the array.

Use the following syntax to add attributes to a deployment plan:

- For simple types:
Enter add "<attribute-name> = {<'string-value'>"|<int>|<true|false>}

Examples:

localhost/deploy > add "forceReinstall = false"
localhost/deploy > add "ip = '192.0.2.23'"

- For attributes that are backed by other struct-like value objects, use the following syntax:
Enter add"<attribute-name> = list or nested object"

localhost/deploy > add "network={gateway='192.0.2.1', userFriendlyName='ip address', ip='192.0.2.4'}"

- If you use JavaScript Objet Notation (JSON) format, use the following syntax:

"{'resourcePlans':[{'hostName':'myhostname','networks':[{'networkBindings':[{'ipAddress':'192.0.2.1'}]}]}]}"

Or

add "resourcePlans=[{hostName='myhostname',networks=[{networkBindings=[{ipAddress='192.0.2.1'}]}]}]"

Or

add "<json-string> "

- For deployment plans on multiple targets that require unique values for each target, use the set command as follows:

add "@<target-uuid or dynamic-target>:<key>=<'string-value'>"|<int>|<true|false>|list of nested objects"
add "<@target-uuid or dynamic-target>:<json-string>"

Example:

localhost/deploy > add @<target-UUID>:"network={gateway='192.0.2.1', userFriendlyName='ip address', ip='192.0.2.2'}"

1.6.6.4 Testing a Deployment Plan

To test a deployment plan, use the dryrun command to create the tasks without committing the job, this ensures no errors with data.

To dry run a deployment plan:

- Enter dryrun.

localhost/deploy > dryrun

1.6.6.5 Applying a Deployment Plan

To execute a deployment plan, set the attributes if required and then apply the plan. Some deployment plans need to have their attributes set before applying the plan.

To apply a deployment plan to an asset:

- Enter apply.

localhost/deploy > apply

1.6.7 Discover

Discover mode allows you to set up and run discovery jobs. You can create a discovery job or use a discovery profile to discover an asset. You can also execute an existing discovery profile.

1.6.7.1 Starting Discover Mode

You must switch to discover mode to run discovery commands.

- Enter discover in the CLI prompt.

localhost > discover
localhost/discover >

1.6.7.2 Creating a Discovery Job

The create submode is used to create and launch new discovery jobs. This submode has its own set of commands.

1. Enter create.

localhost/discover > create
localhost/discover/create >

2. Set the type of discovery job, for example, OS, ILOM, ALOM.

1.6.7.3 Discovering an OS

1. Enter set type=os.

2. Enter the discovery credentials.

- Enter set ssh_user=<user> to set the login user name.

- Enter set ssh_password=<password> to set the login password.

- (Optional) If the login user name is not the root user, enter set ssh_root_user=<root user> to set the root user name.

- (Optional) If the login user name is not the root user, enter set ssh_root_password=<root password> to set the root password.

3. Enter set ipaddrs=<IP address or addresses> to specify the target IP address or addresses. The following formats can be used:

- A single IP address.

- A comma-separated list of IP addresses enclosed in parentheses. Example: (192.0.2.1, 192.0.2.2).

- An IP range in Classless Inter-Domain Routing (CIDR) subnet notation. Example: 192.0.2.1/24.

- An IP range in hyphen notation. Example: 192.0.2.1 - 192.0.2.10.

4. (Optional) Enter set ssh_port=<port> to specify a port.

5. (Optional) Enter set use_default=true|false to specify if the factory default credentials are used or not for the discovery job.

6. (Optional) Enter the show command to display all discovery information. If necessary, use the unset <parameter> command to unset a discovery parameter or clear to reset and revert to default values all configuration data.

7. Enter commit to start the configured discovery job.
The job is launched, and the job ID is displayed.

Example of OS discovery:

localhost/discover > create
localhost/discover/create > set type=os
localhost/discover/create > set ssh_user=sysmgmt
localhost/discover/create > set ssh_password=l0ckit
localhost/discover/create > set ipaddrs=192.0.2.202
localhost/discover/create > show
discovery type: Solaris,Linux OS
use_default=False
ipaddrs=192.0.2.202
ssh_user=sysmgmt
ssh_password=l0ckit
ssh_root_user=
ssh_root_password=
ssh_port=
localhost/discover/create > commit

1.6.7.4 Discovering an ILOM Service Processor

ILOM is the service processor used in some Oracle Sun servers. An ILOM discovery also discovers operating systems.

1. Enter set type=ilom.

2. Enter the discovery credentials.

- Enter set ssh_user=<user> to set the login user name.

- Enter set ssh_password=<password> to set the login password.

- (Optional) If the login user name is not the root user, enter set ssh_root_user=<root user> to set the root user name.

- (Optional) If the login user name is not the root user, enter set ssh_root_password=<root password> to set the root password.

3. Enter set ipaddrs=<IP address or addresses> to specify the target IP address or addresses. The following formats can be used:

- A single IP address.

- A comma-separated list of IP addresses enclosed in parentheses. Example: (192.0.2.1, 192.0.2.2).

- An IP range in CIDR subnet notation. Example: 192.0.2.1/24.

- An IP range in hyphen notation. Example: 192.0.2.1 - 192.0.2.10.

4. Enter set ipmi_user=<IPMI user name>.

5. Enter set ipmi_password=<IPMI user password>.

6. (Optional) Enter the show command to display all discovery information. If necessary, use the unset <parameter> command to unset a discovery parameter or clear to reset and revert to default values all configuration data.

7. Enter commit to start the configured discovery job.
The job is launched, and the job ID is displayed.

1.6.7.5 Discovering an ALOM Service Processor

ALOM is the service processor used in some Oracle Sun servers. An ALOM discovery also discovers operating systems and systems with ILOM service processors.

1. Enter set type=alom.

2. Enter the discovery credentials.

- Enter set ssh_user=<user> to set the login user name.

- Enter set ssh_password=<password> to set the login password.

- (Optional) If the login user name is not the root user, enter set ssh_root_user=<root user> to set the root user name.

- (Optional) If the login user name is not the root user, enter set ssh_root_password=<root password> to set the root password.

3. Enter set ipaddrs=<IP address or addresses> to specify the target IP address or addresses. The following formats can be used:

- A single IP address.

- A comma-separated list of IP addresses enclosed in parentheses. Example: (192.0.2.1, 192.0.2.2).

- An IP range in CIDR subnet notation. Example: 192.0.2.0/24.

- An IP range in hyphen notation. Example: 192.0.2.1 - 192.0.2.2.

4. Enter set telnet_user=<telnet user name>.

5. Enter set telnet_password=<password for telnet user name>.

6. (Optional) Enter the show command to display all discovery information. If necessary, use the unset <parameter> command to unset a discovery parameter or clear to reset and revert to default values all configuration data.

7. Enter commit to start the configured discovery job.
The job is launched, and the job ID is displayed.

1.6.7.6 Viewing Discovery Profiles

You can list all discovery profiles that discover systems.

- Enter list_profiles.
Use the -i| --ids < profile IDs> option to give a specific discovery profile ID or a list of discovery profile IDs. IDs must be separated by a comma.

1.6.7.7 Viewing Discovery Ranges

You can list all the existing discovery ranges that discover systems.

- Enter list_ranges.
Use the -i| --ids <range IDs> option to give a specific discovery range ID or a list of discovery ranges IDs. IDs must be separated by a comma.

1.6.7.8 Viewing Driver Credentials

You can list all driver credentials used to discover systems.

- Enter list_credentials.
Use the -i| --ids <credential IDs> option to give a specific driver credential ID or a list of driver credentials IDs. IDs must be separated by a comma.

1.6.7.9 Viewing Discovery Profile Credentials

You can list all driver credentials for a discovery profile used to discover systems.

- Enter list_profile_credentials -i| --id <discovery profile iD>.

1.6.7.10 Viewing Discovery Ranges

You can list all driver ranges for a discovery profile used to discover systems.

- Enter list_profile_ranges -i| --id <discovery profile iD>.

1.6.7.11 Viewing Networks

You can list all proxy networks used to discover systems.

- Enter list_networks.

1.6.7.12 Executing Discovery Profiles

You can execute a discovery profile to discover systems.

- Enter execute -i| --id <discovery profile id> -t| --targets <target friendly names>.
Use -i| --id <ID> to execute the discovery profile with ID <ID>.

Use -t| --targets <target friendly names> to give a list of target friendly names. Target names must be separated by a comma.

Use the -n| --networkuuid <network UUID> option to give a network UUID.

Use the -c| --credentials <discovery credentials IDs> option to give a specific discovery credential ID or a list of discovery credential IDs. IDs must be separated by a comma.

Use the -m| --management <management credential ID> option to give a management credential ID.

Use the -s| --serviceTag <servicetag credential ID> option to give a service tag credential ID.

Use the -a| --agentLess option to set agentless deployment on.

Use the -r| --ranges <discovery ranges IDs> option to give a list of discovery ranges IDs. IDs must be separated by a comma.

1.6.8 FWImage

Fwimage mode allows you to view and delete firmware images.

1.6.8.1 Starting Fwimage Mode

You must switch to fwimage mode to run firmware image commands.

- Enter fwimage in the CLI prompt.

localhost > fwimage
localhost/fwimage >

1.6.8.2 Viewing Firmware Images

You can view a list of available firmware images.

- Enter list.
Use the -l| --detail option to display a detailed list.

1.6.8.3 Creating a Firmware Image

You can create a firmware image.

1. Enter create.
The image creation submode is launched.

2. Enter add_device -v | --vendor <vendor> -m| --model <model> to add a device for the firmware image.
Use the -v| --validated option to specify a validated image.

3. Enter the criteria for the image using the set command.

- Enter set name=<name> to set the firmware image name.

- Enter set version=<version> to set the firmware version.

- Enter set type=<type>.

- Enter set make=<make>.

- (Optional) Enter set description=<description>.

- (Optional) Enter set size=<size>.

- (Optional) Enter set powerOffRequired=<True|False>. This criteria is set to False by default.

- (Optional) Enter set dependeeFirmwarePackageName=<dependencies>. This criteria is set to None by default.

- (Optional) Enter set updateCount=<update count>.

4. (Optional) Use the show command to show the current criteria. If necessary, use the unset <property> command to unset a property, or use the reset command to clear all criteria.

5. Enter commit to create the new image using your criteria.

1.6.8.4 Updating a Firmware Image

You can update an existing firmware image.

1. Enter update -i| --image <image name>.
The image update submode is launched.

2. Enter the new criteria for the image using the set command.

- Enter set version=<version> to set the firmware version.

- Enter set type=<type> to set the firmware type.

3. Enter commit to update the firmware image.

localhost/fwimage > update -i myimage
localhost/fwimage/update > set version=1.1
localhost/fwimage/update > set type=ALOM-CMT
localhost/fwimage/update > commit
Firmware image updated successfully

1.6.8.5 Deleting a Firmware Image

You can delete any firmware image.

- Enter delete -i| --image <firmware image name>.
The firmware image is deleted.

1.6.9 FWProfile

Fwprofile mode allows you to view and delete firmware profiles.

1.6.9.1 Starting FW Profile Mode

You must switch to fwprofile mode to run firmware profile commands.

- Enter fwprofile in the CLI prompt.

localhost > fwprofile
localhost/fwprofile >

1.6.9.2 Viewing Firmware Profiles

You can view the existing firmware profiles.

- Enter list.
Use the -l| --detail option to display a detailed list.

A list of firmware profiles is displayed.

1.6.9.3 Checking the Status of a Firmware Profile

You can check the status of a firmware profile.

- Enter status -p| --profile <profile name>.
The firmware profile status is displayed.

1.6.9.4 Creating a Firmware Profile

You can create a firmware profile using one or more existing firmware images.

- Enter create -p| --profile <firmware profile name> -i| --images <list of images separated by comma>.
Use the -d| --description <description> option to add a description to the profile.

Use the -r| --reinstall option to force a reinstall when provisioning the firmware.

Use the -g| --downgrade option to force a downgrade when provisioning the firmware.

The firmware profile is created.

1.6.9.5 Updating a Firmware Profile

You can update an existing firmware profile.

- Enter update -p| --profile <firmware profile name> -i | --images <list of images separated by comma>.
Use the -d| --description <description> option to add a description to the profile.

Use the -r| --reinstall option to force a reinstall when provisioning the firmware.

Use the -g| --downgrade option to force a downgrade when provisioning the firmware.

The firmware profile is updated.

1.6.9.6 Deleting a Firmware Profile

You can delete a firmware profile.

- Enter delete -p| --profile <firmware profile name>.
The firmware profile is deleted.

1.6.10 Gear

Use gear mode to view and manage all assets, including operating systems, hardware, and chassis. Although the term for objects that the Enterprise Manager Ops Center software manages is asset, the CLI uses the term gear.

1.6.10.1 Starting Gear Mode

You must switch to gear mode before using other gear subcommands.

- Enter gear in the CLI prompt.

localhost > gear
localhost/gear >

1.6.10.2 Viewing Assets

You can list the assets managed by Oracle Enterprise Manager Ops Center

- Enter list.

localhost/gear > list
Registered Gear:

UFN |Manage state|Description |Asset Type|         UUID         |  Maintenance|
-------------------------------------------------------------------------------
v64v|   MANAGED  |192.0.2.14 |  Server  |abcde-fc-8b-91-abcd51d|NO_MAINTENANCE
c4pr|   MANAGED  |192.0.2.26 |  Server  |abcde-dc-43-82-abcd86d|NO_MAINTENANCE

Use the -l| --detail option to show asset details.

Example

localhost/gear > list -l
Registered Gear:
-------------------------------------------------------------------------------
Name : v64v
Description : 192.0.2.14
Managed State : MANAGED
Status : OK
Lock Info : None
Is a Zone : False
Public UUID : abcde-fc-8b-91-dd2651d
Asset Type : Server
Name : c4pr
Description : 192.0.2.26
Managed State : MANAGED
Status : OK
Lock Info : None
Is a Zone : False
Public UUID : 5a544-dc-43-82-ef8886d
Asset Type : Server

Use the f| --filter <filter term> option to filter the assets list.

Example

localhost/gear > list --filter v64v
Registered Gear:
UFN |Manage state|Description |Asset Type|               UUID                 |
-------------------------------------------------------------------------------
v64v|   MANAGED  |192.0.2.14|  Server  |        6fdg9-fc-8b-91-dd2651

1.6.10.3 Updating Asset Information

You can update the name of any asset, including the Enterprise Controller. You can also update an asset's description and associated tags.

- Enter update -g| --gear <asset name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use the -n| --name <new name> option to give the asset a new name.

Use the -d| --description <description> option to update the asset's description.

Use the -t| --tags <space-separated list of tags> option to update the asset's legacy tags.

Use the -s| --semantictags <space-separated list of tags> option to update the asset's semantic tags.

1.6.10.4 Viewing Jobs Associated With Assets

You can view current and historical jobs associated with an OS, server, or chassis.

- Enter show_jobs -g| --gear <asset name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.5 Managing an Asset

You can manage discovered assets.

- Enter manage -g| --gear <asset name> -u| --user <user name with access to asset> -p| --password <user's password>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use the -t| --type <type> option to give the asset type. This is useful when assets might have the same name.

1.6.10.6 Unmanaging an Asset

You can unmanage a managed asset, removing the asset from the managed asset list and removing any agent.

- Enter unmanage -g| --gear <asset name> -u| --user <user name with access to asset> -p| --password <user's password>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use the -t| --type <type> option to give the asset type. This is useful when assets might have the same name.

1.6.10.7 Setting the Maintenance Mode of an Asset

You can place an asset in maintenance mode or remove an asset from maintenance mode.

- Enter set_maintenance -g| --gear <asset name> on|off.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use the on option to set the asset in maintenance mode.

Use the off option to unset the maintenance mode of an asset.

1.6.10.8 Deleting an Asset

You can delete discovered assets to remove it from Oracle Enterprise Manager Ops Center.

- Enter delete -g| --gear <asset name>
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use the -f| --force option to force the operation.

1.6.10.9 Reinstalling an Agent Controller on an Operating System

You can reinstall an agent on one or more managed operating systems.

- Enter reinstall_agent -g| --gear <comma-separated asset list> -v| --version <Agent version to install> -u| --user <user name> -p| --password <password>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.10 Rebooting an Operating System

You can reboot a managed operating system.

- Enter reboot -g| --gear <OS asset name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.11 Updating Firmware

You can provision updated firmware on one or more systems using an existing firmware profile.

- Enter apply_firmware -g| --gear <comma-separated asset list> -p| --profile <firmware profile>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.12 Checking Firmware Compliance

You can compare the firmware for a list of assets to a firmware profile.

- Enter fwprofile_compliance -g| --gear <comma-separated asset list> -p| --profile <firmware profile>.

1.6.10.13 Provisioning an OS

You can provision a new operating system to a managed system. The provision_os command starts a submode with its own set of subcommands.

1. Enter provision_os -g| --gear <asset name> -p| --profile <profile>.

localhost/gear > provision_os -g targetsystem -p S10
localhost/gear/provision_os# >

2. Use the set command to set the provisioning properties. The properties are:

- profile – The OS profile to use for the provisioning job. Required.

- register – Specifies whether the new OS will be registered. Values are true or false.

- manualnetboot – Values are true or false.

- system_type – The OS that is provisioned. Values are redhat, suse or solaris.

- server_name – The name of the target system. Required.

- hostname – The new host name. Required.

- domain

- netmask

- gateway

- nameserver

- ip_address – The IP address for the OS. Required.

- boot_path

- boot_device

- console_baud

- console

3. (Optional) Use the show command to show the values of all provisioning properties. If necessary, use the unset <property> command to unset a property or the reset command to reset all properties.

4. Use the commit command to launch the OS provisioning job.

1.6.10.14 Changing Locator Lights

You can activate or deactivate locator lights.

- Enter set -g| --gear <asset name> -l| --locator <on|off>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.15 Enabling or Disabling Notifications

You can enable or disable notifications for a specific OS, server, or chassis.

- Enter set -g| --gear <asset name> -n| --notifications <on|off>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.16 Powering Off a Server or Chassis

You can deactivate a managed server or a chassis.

- Enter poweroff -g| --gear <asset name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use the -f| --force option to force the server or chassis to power off.

1.6.10.17 Powering On a Server or Chassis

You can activate a managed server or a chassis.

- Enter poweron -g| --gear <asset name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.10.18 Resetting a Server or Chassis

You can reset a managed server or chassis.

- Enter reset -g| --gear <server or chassis name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

Use -n| --netboot to cause each server to do a netboot instead of booting from disk.

Use the -f| --force option to force the server or chassis to power off.

1.6.10.19 Refreshing a Server

You can refresh the data for a server.

- Enter refresh -g| --gear <server name>.
Use the -U| --UUID <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

Use the --attributes <attribute list> option to give a list of asset attributes instead of the asset name. This is useful when assets might have the same name. The asset attributes that can be used are the type, UUID, UFN, and ip. Attributes must be separated by a comma. The type attribute must be os, server or chassis, and the ip attribute must be a valid IPv4 address.

Examples:

--attributes=ip=192.0.2.1,type='server'

--attributes=type='server',UFN='foo'

1.6.11 Groups

Groups mode allows you to view and manage groups.

1.6.11.1 Starting Groups Mode

You must change to groups mode to run these commands.

- Enter groups in the CLI prompt.

localhost > groups
localhost/groups >

1.6.11.2 Viewing Groups

You can view the list of existing groups.

- Enter list.
Use the -l| --detail option to view a list showing group details.

Use the -b| --brief option to limit the output to group names.

1.6.11.3 Viewing Members of a Group

You can view the members of a group.

- Enter list_members -g| --group <group name>.

1.6.11.4 Viewing Group Memberships

You can view the groups to which an asset belongs.

- Enter list_membership -n| --gear <asset name>.
Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

1.6.11.5 Creating a Group

You can create a group.

- Enter create -g| --group <group> -d| --description <description> -p| --parent <parent group>.
The parent group must already exist.

1.6.11.6 Updating Group Attributes

You can change the name, description, and parent group of a group.

- Enter update -g| --group <group>.
Use the -n| --name <new name> option to rename the group.

Use the -d| --description <new description> option to give the group a new description.

Use the -p| --parent <new description> option to give the group a new parent group.

1.6.11.7 Adding an Asset to a Group

You can add an asset to a group.

- Enter attach -n| --gear <asset name> -g| --group <group>.
Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

1.6.11.8 Removing an Asset From a Group

You can remove an asset from a group.

- Enter detach -n| --gear <asset name> -g| --group <group>.
Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

1.6.11.9 Moving an Asset From One Group To Another Group

You can move an asset from one group to another group.

- Enter move -n| --gear <name of gear> -f| --from_group <current group> -g| --group <destination group>.
Use the -U| --uuid <UUID> option to give the asset public UUID instead of the asset name. This is useful when assets might have the same name.

1.6.11.10 Deleting a Group

You can delete a group. Deleting a group does not affect the assets within the group.

- Enter delete -g| --group <group>.
Use the -c| --child option to indicate if sub-groups under the specified group must be also deleted.

1.6.11.11 Powering on the Assets in a Group

You can power on assets within a group.

- Enter poweron -g| --group <group name>.
Use the -n| --netboot option to cause each server to do a netboot instead of booting from disk.

Deactivated hardware within the group is powered on.

1.6.11.12 Powering off the Assets in a Group

You can power off assets within a group.

- Enter poweroff -g| --group <group name>.
Use the -f | --force option to force the hardware to power off.

Activated hardware within the group is powered off.

1.6.11.13 Resetting Servers in a Group

You can reset servers inside a group.

- Enter reset -g| --group <group>
Use the -f| --force option to force the operation.

Use the -n| --netboot option to cause each server to do a netboot instead of booting from disk.

1.6.12 Incidents

Incidents mode allows you to view and manage existing incidents.

1.6.12.1 Starting Incidents Mode

You must switch to incidents mode to run incidents commands.

- Enter incidents in the CLI prompt.

localhost > incidents
localhost/incidents >

1.6.12.2 Viewing Incidents

You can view a list of existing incidents.

- Enter list.
Use the -e| --emitter option to add to the display the name and the UUID of the asset that is generating the incident.

Use the -l| --detail option to display detailed incidents information.

Use the -s| --state <state> option to filter incidents by <state>.

Use the -u| --user <owner> to filter incidents by <owner>.

1.6.12.3 Viewing Incident Details

You can view details of the existing incidents or a specific incident.

- Enter show -i| --incidents <incident ID or comma-separated incident IDs list>.
Use the -l| --detail option to display detailed incidents information.

1.6.12.4 Viewing Alerts Associated with Incidents

You can view the alerts associated with one or more incidents.

- Enter show_alerts -i| --incidents <incident ID or comma-separated incident IDs list>.
Use the -l| --detail option to display detailed incidents information.

1.6.12.5 Acknowledging an Incident

You can indicate that you are investigating one or more incidents.

- Enter acknowledge -i| --incidents <comma-separated incident IDs list>
Use the -n| --note <note> option to add a note.

1.6.12.6 Adding an Annotation to one or More Incidents

You can add an annotation to one ore more incidents.

- Enter annotate -i| --incidents <comma-sepatared incident IDs list>
Use the -t| --type <annotation type> option to specify an annotation type. Annotation types are comment or suggested_action.

Use the -s| --synopsis <synopsis> option to specify an annotation synopsis.

Use the -n| --note <note> option to add a note.

1.6.12.7 Assigning Incidents

You can assign one or more incidents to a user.

- Enter assign -i| --incidents <comma-separated incident IDs list> -u| --user <user>.
Use the -n| --note <note> option to add a note.

1.6.12.8 Closing Incident

You can close one or more incidents.

- Enter close -i| --incidents <comma-separated incident IDs list>.
Use the -d| --disable-delay <disable delay> option to disable the incident monitoring conditions, and reactivate the monitors after <disable delay> minutes.

Use the -n| --note <note> option to add a note.

1.6.13 Jobs

Use the jobs mode to view existing jobs.

1.6.13.1 Starting Jobs Mode

You must change to jobs mode to run job commands.

- Enter jobs in the CLI prompt.

localhost > jobs
localhost/jobs >

1.6.13.2 Viewing Jobs

You can view a list of jobs.

- Enter list.
The list of current and historical jobs is displayed.

localhost/jobs > list
Job ID                Status               Owner           Job Type
-------------------------------------------------------------------------------
amritsar.5            SUCCESS              root            UpdateGearJob
amritsar.4            SUCCESS              root            DeleteAssetJob
amritsar.3            SUCCESS              root            AgentProvisioningJob
amritsar.2            SUCCESS              root            AgentProvisioningJob
amritsar.1            PARTIALLYSUCCESSFUL  root            DeleteAssetJob

Use the -l| --detail option to view detailed job information.

Use the -f| --filter <term> option to filter the job list.

Use the -o| --owner <job_owner> option to list jobs owned by job_owner.

Use the -s| --status <job_status> option to list jobs with status job_status.

Use the -t| --type <job_type> option to list jobs with job type job_type.

Use the -x| --id <job_id> option to list jobs with job id job_id.

Use the -m| --matchAll option to list jobs that match all of the criteria indicated; default is for any search criteria to match.

Use the -r| --runid <run ID> option to retrieve information of a job with a specific runID.

Use the -C| --limit <limit> option to limit the number of jobs returned.

Use the -A| --ascend option to sort results ascending; default is descending.

Use the -S| --sort <job_attribute> option to sort results on <job_attribute>; default is to sort on job id.

Use the -L| --nologdetails option to not include log details in detailed listing of jobs.

1.6.13.3 Starting a Job

You can run an existing job using its job ID.

- Enter run -x| --id <Job ID>.
Use the --simulate option to run the job in simulation mode.

1.6.13.4 Repeating a Job on Failed Targets

You can re-run a partially successful job on its failed targets.

- Enter rerun_on_failed -x| --id <Job ID>.

1.6.13.5 Deleting a Job

Deleting a job removes the job information from Oracle Enterprise Manager Ops Center. You can only delete jobs that are stopped or completed.

- Enter delete -x| --id <Job ID>.

1.6.13.6 Stopping a Job

Stopping a job ends progress on the job.

- Enter stop -x| --id <Job ID>.
Use the -f| --force option to force the operation.

1.6.14 Monitoring

Monitoring mode allows you to globally manage asset monitoring services.

1.6.14.1 Starting Monitoring Mode

You must switch to monitoring mode to run monitoring commands.

- Enter monitoring in the CLI prompt.

localhost > monitoring
localhost/monitoring >

1.6.14.2 List the monitoring state

You can list the enabled state for the asset monitoring rules.

- Enter list.
The enabled state is displayed with a value of true or false.

Parameters:
Name   |  Value   |
----------------------
Enabled  |   True

1.6.14.3 Enabling monitoring

You can globally enable all asset monitoring rules.

- Enter enable.

1.6.14.4 Disabling monitoring

You can globally disable all asset monitoring rules.

- Enter disable.

1.6.15 Networks

Networks mode allows you to view the list of managed networks.

1.6.15.1 Starting Networks Mode

You must switch to networks mode to run networks commands.

- Enter networks in the CLI prompt.

localhost > networks
localhost/networks >

1.6.15.2 Viewing the List of Managed Networks

You can view the list of managed networks.

- Enter list
A simplified list of managed networks is displayed.

Available networks:
Name    |       UUID            |    CIDR      |
-------------------------------------------------------
192.0.2.0/24.1 | 0123-4567-b730-abcdef | 192.0.2.0/24

Use the -l| --detail option to display a detailed list.

Available networks:
Name   |         UUID        |   CIDR    |VLAN id|Physical| Default GW |
------------------------------------------------------------------------------
192.0.2.0/24.1|0123-4567-b730-abcdef|192.0.2.0/24|   -1  |  True  |192.0.2.1

1.6.16 Notifications

Notifications mode allows you to view notifications.

1.6.16.1 Starting Notifications Mode

You must switch to notifications mode to run notifications commands.

- Enter notifications in the CLI prompt.

localhost > notifications
localhost/notifications >

1.6.16.2 Viewing Notifications

You can view all current notifications.

- Enter list.
A list of notifications is displayed.

localhost/notifications > list
ID   Severity  Type    Message
-------------------------------------------------------------------------------
1    MEDIUM    INFO    Enterprise Controller registered with Sun. (70002)
2    MEDIUM    INFO    Proxy Controller proxyone (192.0.2.185) has b...
3    MEDIUM    INFO    Proxy Controller proxytwo (192.0.2.218) has b...

Use the -l| --detail option to display a detailed list.

Use the -f| --filter <filter term> option to filter the notifications.

Use the -s| --severity <severity> option to display only notifications of given severity [HIGH|MEDIUM|LOW].

Use the -c| --count <max> option to specify a maximum count of notifications to display.

Use the -u| --username <user> option to display only notifications belonging to a user.

Use the -i| --notification_id <ID> option to display notifications of a specific ID.

Use the -r| --status <status> option to display only notifications according to their status [READ|UNREAD]. Default is to display both.

1.6.16.3 Deleting a Notification

You can delete a notification using its ID number.

- Enter delete -i| notification_id <notification ID number>.

localhost > delete -i 43
Successfully deleted notification

Use the -u| --username <user> option to delete notifications belonging to a user.

1.6.17 OSImage

OS image mode allows you to view and manage OS images.

1.6.17.1 Starting OS Image Mode

You must switch to OS image mode to run OS image commands.

- Enter osimage in the CLI prompt.

localhost > osimage
localhost/osimage >

1.6.17.2 Viewing OS Images

You can view OS images.

- Enter list.
Use the -l| --detail option to view a detailed list.

1.6.17.3 Importing an OS Image

You can import an OS image when it is located to the Enterprise Controller's local file system.

- Enter import -f| --filename <image file name and location> -d| --description <description> -n| --name <image name>.

localhost/osimage > import -f folder/location/image.iso -d Solaris 10 -n Solaris 10
JobId = EnterpriseController.47

1.6.17.4 Deleting an OS Image

You can delete OS images.

- Enter delete -n| --name <image name>.

1.6.18 OSProfile

OS profile mode allows you to view, import, and export operating system profiles.

1.6.18.1 Starting OS Profile Mode

You must switch to OS profile mode to run OS profile commands.

- Enter osprofile in the CLI prompt.

localhost > osprofile
localhost/osprofile >

1.6.18.2 Viewing OS Profiles

You can view OS profiles.

- Enter list.
Use the -l| --detail option to view a detailed list.

localhost/osprofile > list
Profile Name: sles10Jeff1
Description: sles10Jeff1
Distro Name: sles10
OS Version: SUSE-Linux-Enterprise-Server-SP2-10.2-0
Platform: x86

1.6.18.3 Importing a JET Template

You can import a JET template.

- Enter import_jet_template -p| --profile <profile name> -i| --image <OS image> -t| --template_path <local template path>.

1.6.18.4 Importing an OS Profile

You can import an OS profile file. If you are importing a profile that you have previously exported, change the 'Name' and 'Payload_Name' fields before importing.

- Enter import -f| --file <profile name>

1.6.18.5 Exporting an OS Profile

You can export an OS profile to a designated file.

- Enter export -p| --profile <profile name> -f| --file <file name.prof>.

1.6.18.6 Copying an OS Profile

You can make a new profile by copying an existing profile.

- Enter clone -p| --profile <original profile name> -n| --name <new profile name>.

1.6.18.7 Deleting an OS Profile

You can delete an existing profile.

- Enter delete -p| --profile <profile name>.

1.6.19 Reports

Reports mode allows you to perform actions related to the reporting service such as viewing the collection of samples, called partitions, deleting a partition, applying the rollup and cleanup processes to a partition, and reverting the rollup process.

1.6.19.1 Starting Reports Mode

You must switch to reports mode to run report commands.

- Enter reports in the CLI prompt.

localhost > reports
localhost/reports >

1.6.19.2 Checking the Status of the Reporting Service

You can view the current status of the reporting service.

- Enter show.

1.6.19.3 Starting the Reporting Service

You can start the reporting service without restarting the Enterprise Controller.

- Enter start.

1.6.19.4 Stopping the Reporting Service

You can stop the reporting service without stopping the Enterprise Controller.

- Enter stop.

1.6.19.5 Viewing Partitions

You can view a list of all the partitions managed by the reporting service. A partition is the collection of all samples compiled during one day between 12:00 a.m. and 11:59:59 p.m.

- Enter list.

1.6.19.6 Viewing Detailed Partition Information

You can view detailed information about a partition, including its state, and the number of daily, hourly, weekly, monthly, or stats samples.

- Enter partition -p| --id <partition ID>.
Use the -s| --state option to display the partition's state.

Use the -k| --hourly option to display the number of hourly samples.

Use the -d| --daily option to display the number of daily samples.

Use the -w| --weekly option to display the number of weekly samples.

Use the -m| --monthly option to display the number of monthly samples.

Use the -t| --stats option to display the number of stats samples.

Use the -f| --full option to display all the information about a partition.

1.6.19.7 Viewing Assets Associated to a Partition

You can view a list of assets with at least one sample in a specific partition.

- Enter urns -p| --id <partition ID>
Use the -u| --urn <urn name> option to specify the asset for which the list of attributes is requested. An urn name is an object name. If no urn name is given, the list of urns that have at least one sample in the partition is shown. This list includes the number of samples for each urn.

Use the -q| --quiet to avoid displaying warning messages.

1.6.19.8 Checking Partitions

You can check the partitions to determine if a conversion is necessary.

- Enter check.

1.6.19.9 Converting Partition Samples to a new Format

You can convert samples of a partition to a new format.

- Enter convert.

Use the -p| --id <partition ID> option to specify a partition.

Use the -n| --n <number of samples> option to specify the number of samples.

Use the -q| --quiet to avoid displaying warning messages.

1.6.19.10 Purging old Format Partition Samples

You can purge the old format partition samples.

- Enter purge.
Use the -p| --id <partition ID> option to specify a partition.

Use the -n| --n <number of samples> option to specify the number of samples.

Use the -q| --quiet to avoid displaying warning messages.

1.6.19.11 Enabling Automatic Rollup and Cleanup

You can enable automatic rollup to calculate an average of samples, and cleanup to remove very old samples in a partition.

- Enter enable.

1.6.19.12 Disabling Automatic Rollup and Cleanup

You can disable automatic rollup and cleanup in a partition.

- Enter disable.

1.6.19.13 Starting Manual Rollup

You can manually start the rollup process for a specific partition. The rollup process calculates the average of samples in a partition, it is started every hour, and operates on one partition at a time. To use this command, the automatic rollup should be disabled. For more information about how to disable the automatic rollup process, see Disabling Automatic Rollup and Cleanup.

- Enter rollup.
Use the -p| --id <partition ID> option to specify a partition. If no partition is given, the reporting service automatically selects the oldest partition that has not been rolled up.

Use the -t| --t <milliseconds> option to specify a pause time in milliseconds.

Use the -q| --quiet to avoid displaying warning messages.

1.6.19.14 Starting Manual Cleanup

You can manually start the cleanup process. The cleanup process removes very old samples. This process is started every hour, and it removes only the partitions that are previously rolled-up. For more information about how to roll-up a partition, see Starting Manual Rollup.

- Enter cleanup.
Use the -t| --t <milliseconds> option to specify a pause time in milliseconds.

Use the -q| --quiet to avoid displaying warning messages.

1.6.19.15 Viewing Detailed Rollup and Cleanup Information

You can view detailed information about the rollup and cleanup processes.

- Enter info.

1.6.19.16 Viewing Rollup and Cleanup Statistics

You can view the statistics related to the rollup and cleanup processes. This information includes counters and gauges data.

- Enter stats.

1.6.19.17 Resetting Rollup Statistics

You can reset the statistics related to the rollup and cleanup processes. The counters and gauges are reset.

- Enter reset_stats.

1.6.19.18 Setting the Pause Time

You can set the pause time used for the rollup and cleanup processes. This value is set in milliseconds, and the default value in the reporting service configuration is 1000 milliseconds.

- Enter pause -t| --t <milliseconds>.

1.6.19.19 Resetting a Partition

You can reset a specific partition to revert the effects of a rollup that has been previously applied.

- Enter reset -p| --id <partition ID>.
Use the -t| --t <milliseconds> option to specify a pause time in milliseconds.

Use the -q| --quiet to avoid displaying warning messages.

1.6.19.20 Deleting a Partition

You can delete a specific partition

- Enter delete -p| --id <partition ID>.
Use the -t| --t <milliseconds> option to specify a pause time in milliseconds.

Use the -q| --quiet to avoid displaying warning messages.

1.6.20 ServerPools

Serverpools mode allows you to view the existing server pools, and to list and remove a member from a server pool.

1.6.20.1 Starting Serverpools Mode

You must switch to serverpools mode to run server pool commands.

- Enter serverpools in the CLI prompt.

localhost > serverpools
localhost/serverpools >

1.6.20.2 Viewing Server Pools

You can view a list of existing server pools.

- Enter list.

1.6.20.3 Viewing Members of a Server Pool

You can view the members of a server pool.

- Enter list_members -U| --UUID <Server Pool UUID>.
Use the -l|--detail option to include detailed credential information.

1.6.20.4 Removing a Member From a Server Pool

You can remove a member or a list of members from a server pool.

- Enter remove_members -U| --UUID <Server Pool UUID> -M| --members <Server UUID>.
Use the -f|--force option to force the server removal from the server pool.

1.6.21 Stats

In stats mode, you view statistics about the Enterprise Controller:

- Percentage of memory used

- Free memory (MB)

- Average load (15 minutes)

- CPU utilization percentage

1.6.21.1 Starting Stats Mode

You must switch to stats mode to run stats commands.

- Enter stats in the CLI prompt.

localhost > stats
localhost/stats >

1.6.21.2 Viewing Statistics

You can view statistics about the Enterprise Controller.

- Enter show.

Name                  Used Mem %   Free Mem (MB)  Avg Load 15min  CPU Util %
-------------------------------------------------------------------------------
EnterpriseController  34.28         6646          1.74             75.00
EnterpriseController  34.28         6646          1.74             75.00
EnterpriseController  34.28         6646          1.74             75.00

Use the -i| --interval <interval> option to specify a repeat interval in seconds.

1.6.22 Update

Update mode allows you to view and manage policies, profiles, and snapshots for OS updates.

1.6.22.1 Starting Update Mode

You must change to update mode to run these commands.

- Enter update in the CLI prompt.

localhost > update
localhost/update >

1.6.22.2 Viewing OS Update Policies

You can view the available OS update policies.

- Enter list_policies.
Use the -l| --detail option to display a detailed list.

Use the -p| --policyname <profile_name> option to display policies with a specific policy name.

1.6.22.3 Viewing OS Update Profiles

You can view the available OS update profiles.

- Enter list_profiles.
Use the -l| --detail option to display a detailed list.

Use the -p| --profilename <profile name> option to display profiles with a specific profile name.

1.6.22.4 Viewing OS Distributions

You can view the available distributions. By default, this command shows only active distributions.

- Enter list_distros.
Use the -a| --all option to display inactive and active distributions.

1.6.22.5 Viewing Snapshots

You can view the snapshots for a specific asset.

- Enter list_snapshots -g| --gear <asset name>.

1.6.22.6 Searching Inventory

You can search an OS asset or all assets for inventory whose name matches a search string. The search string used for this command must be a regular expression. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html.

- Enter search_inventory -s| --search_string <search string>.
Enter the -g| --gear <asset name> option to search a specific asset, or use the -a| --allgear option to search all gear. You must use one of these two options.

Use the -t| --snapshot <snapshot name> option to search for a specific snapshot. This option can only be used with the -g option.

Use the -D| --description option to search descriptions.

Use the -c| --cvs option to output to comma-separated values (CSV).

Use the -f| --filename <filename> option to specify a filename for CSV output.

Use the -d| --delimiter <delimiter> option to specify a delimiter character. The default is the pipe (|) character.

Use the -e| --enclosure <enclosure> option to specify an enclosure character. The default is the quote (") character.

Use the -p| --append option to append the data to an existing file.

Use the -l| --detail option to display detailed data.

1.6.22.7 Checking Inventory

You can check an OS asset to see if inventory is available for it.

- Enter check_inventory.
Enter the -g| --gear <asset name> option to check a specific asset, or use the -a| --allgear option to check all assets. You must use one of these two options.

Use the -t| --snapshot <snapshot name> option to check a specific snapshot. This option can only be used with the -g option.

Use the -c| --cvs option to output to comma-separated values (CSV).

Use the -f| --filename <filename> option to specify a filename for CSV output.

Use the -d| --delimiter <delimiter> option to specify a delimiter character. The default is the pipe (|) character.

Use the -e| --enclosure <enclosure> option to specify an enclosure character. The default is the quote (") character.

Use the -r| --header option to include a header line.

Use the -p| --append option to append the asset data to an existing file.

1.6.22.8 Checking Connectivity to the Knowledge Base

You can check the connectivity to the knowledge base.

- Enter check_guus.
Use the -u| --user <user name> option to specify a user name.

Use the -p| --password <password> option to specify a password.

Use the --proxy <proxy host name> option to specify a proxy.

Use the --port <proxy port> option to specify a proxy port.

Use the --proxyuser <proxy user name> option to specify a proxy user name.

Use the --proxypass <proxy password> option to specify a proxy password.

1.6.22.9 Querying Job History

You can view the job history for a specific OS asset.

- Enter job_history -g| --gear <asset list>.
Use the -l| --detail option to show a detailed listing.

Use the -f| --fromdate <from date YYYYMMDD> option to specify a from date. The default is seven days ago.

Use the -t| --todate <to date YYYYMMDD> option to specify an end date. The default is today.

Use the -i| --jobids < job ID> option to query a specific job or jobs, you must still supply the asset name.

Use the -L| --log option to print logs.

Use the --fail option to query failed status.

Use the --ok option to query ok status.

Use the --warning option to query warning status.

Use the --nostatus option to query nostatus status.

Use the --install option to query install action.

Use the --upgrade option to query upgrade action.

Use the --uninstall option to query uninstall action.

Use the --downgrade option to query downgrade action.

1.6.22.10 Querying Job Status

You can query job status.

- Enter get_job_status.
Enter the -i| --jobids <job ID> option to query specific jobs, or use the -a| --alljobs option to query all jobs. You must use one of these two options.

Use the -l| --detail option to print out detail, including logs if available.

Use the -c| --cvs option to output to comma-separated values (CSV).

Use the -f| --filename <filename> option to specify a filename for CSV output.

Use the -d| --delimiter <delimiter> option to specify a delimiter character. The default is the pipe (|) character.

Use the -e| --enclosure <enclosure> option to specify an enclosure character. The default is the quote (") character.

Use the -r| --header option to include a header line.

Use the -p| --append option to append the asset data to an existing file.

1.6.22.11 Uploading a Knowledge Base Bundle

Knowledge base bundles contain current patch data. A knowledge base bundle must be moved to the system running the Enterprise Controller before it can be uploaded.

- Enter load_kb_bundle -f| --filename <path to KB bundle>.

1.6.22.12 Checking the Connection Mode

You can check the connection mode.

- Enter check_disconnected.

1.6.22.13 Changing to Connected Mode

You can change the Enterprise Controller from disconnected to connected mode.

- Enter set_connected_mode -c| --connected.

1.6.22.14 Changing to Disconnected Mode

You can change the Enterprise Controller from connected to disconnected mode.

- Enter set_connected_mode -d| --disconnected

1.6.22.15 Modifying an OS Asset

You can update a specific OS asset by installing, upgrading, and uninstalling specific packages and patches

- Enter modify_gear -g| --gear <assetname> -y| --policy <policy name> -a| --actual.
Omit the -a option to run the job as a simulation.

Use the --si <search string> option to specify a search term to add to the install list.

Use the --su <search string> option to specify a search term to add to the upgrade list.

Use the --sr <search string> option to specify a search term to add to the uninstall list.

The search strings used for this command must be regular expressions. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html.

Use the --ni <node IDs to install> option to specify node IDs for install.

Use the --nu <node IDs to upgrade> option to specify node IDs for upgrade.

Use the --nr <node IDs to uninstall> option to specify node IDs for uninstall.

Use the -j| --jobname <job name> option to specify a job name.

Use the -e| --jobdesc <job description> option to specify a job description.

Use the -k| --taskname <taskname> option to specify a task name.

Use the -f| --profilename <profile name> option to specify a profile name.

Use the -D| --description <profile description> option to specify a profile description.

Use the -r| --failure_policy <failure policy> option to specify a failure policy.

Use the -x| --execution_policy <execution policy> option to specify an execution policy.

Use the -o| --seconds <number of seconds> option to wait a specified number of seconds before running the job.

Use the -c| --case option to run a case sensitive search.

Use the -d| --desc option to search the description.

Example:

localhost/update > modify_gear -g "foo.example.com" --sr SUNWbzip -y "Yes To All" -a

1.6.22.16 Applying an Update Profile to an OS Asset

You can apply a profile to an asset, updating all packages and patches to match the profile.

- Enter apply_profile_to_gear -g | --gear <assetname> -y| --policy <policy name> -f| --profilename <profile name> -a| --actual
Omit the -a option to run the job as a simulation.

Use the -j| --jobname <job name> option to specify a job name.

Use the -e| --jobdesc <job description> option to specify a job description.

Use the -k| --taskname <taskname> option to specify a task name.

Use the -r| --failure_policy <failure policy> option to specify a failure policy.

Use the -x| --execution_policy <execution policy> option to specify an execution policy.

Use the -o| --seconds <number of seconds> option to wait a specified number of seconds before running the job.

The following is an example of a CLI command to deploy a profile job to one or more hosts:

localhost/update > apply_profile_to_gear -g <space separated list of host names> -y "Yes To All" -f <profile name>

1.6.22.17 Creating a Historical Snapshot

You can create a historical snapshot.

- Enter create_historical_snapshot -g| --gear <asset name> -s| --snapshotname <snapshot name> -D| --description <snapshot description>.

1.6.22.18 Deleting a Snapshot

You can delete an existing snapshot of an asset.

- Enter delete_snapshots -g| --gear <asset name> -s| --snapshot <snapshot name>.

1.6.22.19 Creating a Profile

You can create a new profile by specifying packages and patches to install, upgrade, and uninstall.

- Enter create_profile.
You must supply a search string or node id. The search string used for this command must be a regular expression. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html.

Use the --si <search string> option to specify a search term to add to the install list.

Use the --su <search string> option to specify a search term to add to the upgrade list.

Use the -sr <search string> option to specify a search term to add to the uninstall list.

Use the --ni <node IDs to install> option to specify node IDs for install.

Use the --nu <node IDs to upgrade> option to specify node IDs for upgrade.

Use the --nr <node IDs to uninstall> option to specify node IDs for uninstall.

Use the -f| --profilename <distribution name> option to specify a profile name.

Use the -o| --distro <profile name> option to limit by distro name.

Use the -C <channel name> option to specify the channel name for all subcommands.

Use the -D| --description <profile description> option to specify a profile description.

Use the -t| --type <profile description> option to specify a profile type.

Use the -a| --all option to include all matched packages/patches.

Use the -c| --case option to run a case sensitive search.

Use the -r| --replace option to replace an existing profile if the names are the same.

Use the -p| --loop option to restrict the maximum number of inventory items found in a host.

1.6.22.20 Creating a Profile From Inventory

You can create a new OS profile based on an existing system.

- Enter create_profile_from_inventory -g| --gear <gear name>.
Use the -t| --snapshot <snapshot name> option to search for a specific snapshot. This option can only be used with the -g option.

Use the -f| --profilename <profile name> option to specify a profile name.

Use the -D| --description <profile description> option to specify a profile description.

Use the -r| --include_removes option to include removed packages.

1.6.22.21 Deleting a Profile

You can delete a profile.

- Enter delete_profiles -p| --profilename <profile name>.

1.6.22.22 Adding a File to a Distribution

You can add a file stored on the Enterprise Controller to a distribution.

- Enter add_file_to_distro -f| --file_path <full path to distribution> -o| --distro_name <distro name> -a| --category_name <category name> -C| --channelname <channel name> -s | --security.

1.6.22.23 Uploading Local Software in Bulk From a Directory

You can upload the content from a directory and its subdirectories to the Updates software library.

- Enter bulk_upload_directory -D| --distribution <distribution name of uploaded files> -d| --directory <full path to the source directory> -C| --channelname <channel name>.

Note:
For more information about how to view the available distributions, see Viewing OS Distributions

1.6.22.24 Adding a Local Action

You can add a local action.

- Enter add_local_action -a| --actionname <action name> -f| --filename <file name> -p| --parentname <parent category name> -D| --description <description> -C| --channelname <channel name> -t.
The action type must be macro, postaction, preaction, or probe.

1.6.22.25 Adding a Local Category

You can add a local category.

- Enter add_local_category -c| --category_name <category name> -p| --parent_name <parent name> -D| --description <description> -C| --channelname <channel name>.

1.6.22.26 Deleting a Component

You can delete a component.

- Enter delete_component -i| --nodeid <node id> -d| --distro <distro> -C | --channelname <channel name>.
Use the -k| --donotcheckforinstall option to refrain from checking for install.

1.6.22.27 Adding a Configuration File

You can add a configuration file.

- Enter add_configuration_file -f| --filename <filename> -p| --pathname <path name to file> -v| --version <version> -c| --categoryname <category name> -D| --description <description> -C| --channelname <channel name>.

1.6.22.28 Setting a Component File

You can set a component file.

- Enter set_component_file -n| --componentname <component name> -C| --channelname <channel name> -f| --filename <file name>.

1.6.22.29 Finding Nodes

You can find nodes whose names match a search string. The search string used for this command must be a regular expression. For a summary of regular expression constructs, visit http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html.

- Enter find_nodes -s| --search_string <search string>.
Use the -a| --all option to list all nodes.

Use the -l| --detail option to print details.

Use the -c| --case option to specify a case-sensitive search.

As the following examples shows, when regular expressions are not used correctly, any node is listed as a result:

localhost/update > find_nodes -s SMCcurl-7.21* -a
Name                           Node id    Distro          Available  Certified
-------------------------------------------------------------------------------

localhost/update > find_nodes -s SMCcurl-7.21.2-0 [1/1/2012] -a
Name                           Node id    Distro          Available  Certified
-------------------------------------------------------------------------------

Correct examples:

localhost/update > find_nodes -s SMCcurl-7.21.* -a
Name                           Node id    Distro          Available  Certified
-------------------------------------------------------------------------------
SMCcurl-7.21.0-0 [1/1/2012]   41025315   SOLARIS10_SPARC  True       True
SMCcurl-7.21.1-0 [1/1/2012]   41125695   SOLARIS10_SPARC  True       True
SMCcurl-7.21.2-0 [1/1/2012]   42327548   SOLARIS10_SPARC  True       True

EnterpriseContoller/update > find_nodes -s SMCcurl-* -a
Name                           Node id    Distro          Available  Certified
-------------------------------------------------------------------------------
SMCcurl                        41002397   SOLARIS10_SPARC False      True
SMCcurl                        46108251   SOLARIS9_SPARC  False      True
SMCcurl                        52104822   SOLARIS10_X86   False      True

1.6.23 User

User mode allows you to view and manage local and remote users and their roles.

1.6.23.1 Starting User Mode

You must switch to user mode to run these commands.

- Enter user in the CLI prompt.

localhost > user
localhost/user >

1.6.23.2 Viewing Users

You can view the existing users in the Enterprise Controller.

- Enter show_local_users.
A list of users is shown.

Use the -r| --roles <role name> option to view users with <role name> role. A list of users and their roles are shown.

1.6.23.3 Viewing Role Types

You can view the available role types in the Enterprise Controller.

- Enter show_all_local_roles.

1.6.23.4 Viewing User Roles

You can view the roles assigned to a specific user in the Enterprise Controller.

- Enter show_local_user_roles -u| --user <user name>.

1.6.23.5 Adding a User to the Enterprise Controller

You can add a user to the Enterprise Controller and grant a role to the new user. The user must already exist in the host where the Enterprise Controller is installed.

- Enter add_local_user -u| --user <user name> -r| --role <role or comma-separated roles list>.
For information about the available role types you can grant to a user, see Viewing Role Types.

1.6.23.6 Granting Roles to a User

You can grant a user role to a user of the Enterprise Controller.

- Enter grant_local_role -u| --user <user name> -r| --role <role or comma-separated roles list>.
For information about the available role types you can grant to a user, see Viewing Role Types.

1.6.23.7 Replicating User Roles

You can replicate the roles from a source user to a recipient user. The current roles and privileges of the recipient users are overwritten with the roles and privileges of the source user.

- Enter replicate_user_roles -u|--user <source user> -r| --role <recipient user>.

1.6.23.8 Removing Roles From a User

You can remove a role from a user of the Enterprise Controller. For more information about how to see the roles of a user, see Viewing User Roles.

- Enter revoke_local_role -u| --user <user name> -r| --role <role or list of comma-separated roles to remove>.

1.6.23.9 Adding a Directory Server

You can add a directory server.

1. Enter configureds.

localhost/user > configureds
localhost/user/configureds >

2. Enter set name=<name> to set the directory server name.

3. Enter set hostname=<host name> to set a fully qualified host name.

4. Enter set use_ssl=<false|true> if you want to enable or disable SSL. Default is false.

5. Enter set port=<port> to set a port.

6. Enter set user=<user name> to set a user name to connect with.

7. Enter set password=<password> to set a password.

8. Enter set root_suffix=<root suffix> to set the root suffix.

9. Enter set user_dn=<user DN> to set the user search DN.

10. Enter set user_scope=<user scope> to set the user search scope.

11. Enter set search_filter=<search filter> to set the user search filter.

12. (Optional) Use the show command to show the values of all directory server properties. If necessary, use the unset <property> command to unset a property or the reset command to reset all properties.

13. Use the commit command to finish configuring the directory server.

1.6.23.10 Viewing Directory Servers

You can view a list of directory servers and their IDs.

- Enter get_directory_servers.
Use the -d| --details option to show directory server details.

1.6.23.11 Viewing Remote Users

You can get a list of directory server users and their roles.

- Enter get_ds_users -d| --directory <directory server name>.
Use the -r| --roles <role> option to filter users with <role> role.

1.6.23.12 Synchronizing All Remote Users

You can synchronize all directory server users and their roles with the cache on the Enterprise Controller.

- Enter sync_all_ds_users -d| --directory <directory server name>.

1.6.23.13 Synchronizing a Single User

You can synchronize a specific user on the directory server with the cache on the Enterprise Controller.

- Enter sync_ds_user -d| --directory <directory server name> -u| --user <user>.

1.6.23.14 Removing a Directory Server

You can remove a directory server from the Enterprise Controller.

- Enter remove_directory_service -d| --directory <directory server name>.

1.6.23.15 Deleting a User

You can delete a local user in the Enterprise Controller.

- Enter delete_local_user -u| --user <user name>.

1.6.24 Virtualization

The virtualization mode manages virtual hosts and virtual machines (Oracle Solaris zones only).

1.6.24.1 Starting Virtualization Mode

You must switch to virtualization mode to run virtualization commands.

- Enter virtualization in the CLI prompt.

localhost > virtualization
localhost/virtualization >

1.6.24.2 Viewing Hosts

You can view the list of guest containers (global zones).

- Enter list_hosts.

1.6.24.3 Viewing Guests

You can view the list of non-global zones for a specific global zone.

- Enter list_guests -C| --container-on <global zone name>.

1.6.24.4 Migrating a Non-Global Zone

You can detach a non-global zone from its non-functioning global zone and attach the non-global zone to a different global zone.

- Enter startup (-z zonename -S ObjectName | -Z ObjectName) -D ObjectName.
Use the -z| --zonename option to specify a guest (non-global zone). If you select this option you must specify a source global zone object name.

Use the -S| --source-on option if you specify a zonename before. Using this option you specify a source global zone object name.

Use the -Z| --zone-on option in case you did not select the -z| --zonename option. Using this option you indicate the host (global zone) object name.

Use the -D| --destination option to indicate the destination (global zone).

1.6.25 Finding the Equivalent Browser User Interface Actions For the Mode Commands

You can use the Oracle Enterprise Manager Ops Center browser user interface (BUI) instead of using the command-line interface. You can find in the browser user interface many, but not all, equivalent actions for the CLI mode commands.

The following charts show the mode commands that have a corresponding action in the browser user interface:

- Controllers Mode

- Credentials Mode

- Deploy-Setup Mode

- Deploy Mode

- Discover Mode

- FWImage Mode

- FWProfile Mode

- Gear Mode

- Groups Mode

- Incidents Mode

- Jobs Mode

- Notifications Mode

- OSImage Mode

- OSProfile Mode

- ServerPools Mode

- Update Mode

- User Mode

- Virtualization Mode

1.6.25.1 Controllers Mode

Table 1-7 shows the commands included in the Controllers mode and their equivalent actions in the BUI.

Table 1-6 Controllers Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Open the alert indicating that a Proxy Controller has failed> Migrate Assets> Auto Balance across Proxy Controllers> Migrate

migrate_assets

Open the alert indicating that a Proxy Controller has failed> Migrate Assets> Auto Balance across Proxy Controllers> Migrate

1.6.25.2 Credentials Mode

Table 1-7 shows the commands included in the Credentials mode and their equivalent actions in the BUI.

Table 1-7 Credentials Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Administration> Enterprise Controller> Credentials

modify

Navigation Pane> Administration> Enterprise Controller> Credentials> Edit Credentials

1.6.25.3 Deploy-Setup Mode

Table 1-8 shows the commands included in the Deploy-Setup mode and their equivalent actions in the BUI.

Table 1-8 Deploy-Setup Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

plan

Navigation Pane> Plan Management> Deployment Plans

target

Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Action Pane> Apply Deployment Plan

1.6.25.4 Deploy Mode

Table 1-9 shows the commands included in the Deploy mode and their equivalent actions in the BUI.

Table 1-9 Deploy Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

show plan

Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Center Pane> Details tab

show

NA

show results

Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Center Pane> Results tab

set

Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Actions Pane> Edit Deployment Plan

add

NA

dryrun

NA

apply

Navigation Pane> Plan Management> Deployment Plans> Select a type of plan> Select a plan> Actions Pane> Apply Deployment Plan

1.6.25.5 Discover Mode

Table 1-10 shows the commands included in the Discover mode and their equivalent actions in the BUI.

Table 1-10 Discover Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

create

NA

list_profiles

Navigation Pane> Plan Management> Profiles and Policies> Discovery

list_ranges

NA

list_credentials

Navigation Pane> Administration> Enterprise Controller> Credentials

list_profile_credentials

Navigation Pane> Plan Management> Profiles and Policies> Discovery> Select a Discovery Profile> Discovery Credentials table in the Center Pane.

list_profile_ranges

NA

list_networks

NA

execute

Navigation Pane> Plan Management> Profiles and Policies> Discovery> Select a Discovery Profile> Actions Pane> Add Assets

1.6.25.6 FWImage Mode

Table 1-11 shows the commands included in the FWImage mode and their equivalent actions in the BUI.

Table 1-11 FWImage Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

NA

create

NA

update

Navigation Pane> Libraries> Software Libraries> Initial EC Library> Actions Pane> Upload Firmware

delete

NA

1.6.25.7 FWProfile Mode

Table 1-12 shows the commands included in the FWProfile mode and their equivalent actions in the BUI.

Table 1-12 FWProfile Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Plan Management> Profiles and Policies> Firmware

status

NA

create

Navigation Pane> Plan Management> Profiles and Policies> Firmware> Actions Pane> Create Profile

update

Navigation Pane> Plan Management> Profiles and Policies> Firmware> Center Pane> Edit

delete

Navigation Pane> Plan Management> Profiles and Policies> Firmware> Center Pane> Delete

1.6.25.8 Gear Mode

Table 1-13 shows the commands included in the Gear mode and their equivalent actions in the BUI.

Table 1-13 Gear Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Assets> All Assets

update

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Edit Attributes or Edit Tags

show_jobs

Navigation Pane> Assets> All Assets> Jobs tab

manage

NA

unmanage

NA

set_maintenance

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Place in Maintenance Mode or Remove From Maintenance Mode

delete

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Delete Assets

reinstall_agent

Navigation Pane> Assets> All Assets> Select an OS> Actions Pane> Switch Management Access

reboot

Navigation Pane> Assets> All Assets> Select an OS> Actions Pane> Reboot

apply_firmware

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Update Firmware

fwprofile_compliance

NA

provision_os

Navigation Pane> Plan Management> Deployment Plans> Provision OS> Select a Plan> Actions Pane> Apply Deployment Plan

set (locator lights)

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Locator Lights On or Locator Lights Off

set (notifications)

NA

poweroff

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Power Off

poweron

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> Power On

reset

Navigation Pane> Assets> All Assets> Select a server Actions Pane> Reset Server(s)

refresh

Navigation Pane> Assets> All Assets> Select a server Actions Pane> Refresh

1.6.25.9 Groups Mode

Table 1-14 shows the commands included in the Groups mode and their equivalent actions in the BUI.

Table 1-14 Groups Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list (Predefined Groups)

Navigation Pane> Assets> Server, Chassis, Operating Systems or All User Defined Groups

list_members

Navigation Pane> Assets> Server, Chassis, Operating Systems or All User Defined Groups

list_membership

Navigation Pane> Assets> Server, Chassis, Operating Systems or All User Defined Groups

create

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Create Group

update

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Edit Group

attach

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Add Asset to Group

detach

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Remove Asset from Group

move

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Move Asset to Group

delete

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Delete Group

poweron

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Power On

poweroff

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Power Off

reset

Navigation Pane> Assets> All User Defined Groups> Actions Pane> Reset Server (s)

1.6.25.10 Incidents Mode

Table 1-15 shows the commands included in the Incidents mode and their equivalent actions in the BUI.

Table 1-15 Incidents Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others

show

Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others

acknowledge

Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Acknowledge Incident(s)

annotate

Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Add Annotation to Incident(s)

assign

Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Assign Incident(s)

close

Navigation Pane> Message Center> Unassigned Incidents, My Incidents or Incidents Assigned to Others> Close Incident(s)

1.6.25.11 Jobs Mode

Table 1-16 shows the commands included in the Jobs mode and their equivalent actions in the BUI.

Table 1-16 Jobs Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Jobs Pane

run

Jobs Pane> Select a job> Re-Run Selected Jobs

rerun_on_failed

Jobs Pane> Select a failed job> Re-Run Selected Jobs

delete

Jobs Pane> Select a job> Delete Selected Jobs

stop

Jobs Pane> Select a job> Stop Selected Jobs

1.6.25.12 Notifications Mode

Table 1-17 shows the commands included in the Notifications mode and their equivalent actions in the BUI.

Table 1-17 Notifications Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Message Center>

delete

Navigation Pane> Message Center> Select a Notification> Delete

1.6.25.13 OSImage Mode

Table 1-18 shows the commands included in the OSImage mode and their equivalent actions in the BUI.

Table 1-18 OSImage Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Libraries> Software Libraries> Initial EC Library> Actions Pane> Import Image

import

Navigation Pane> Libraries> Software Libraries> Initial EC Library> Actions Pane> Import Image

delete

NA

1.6.25.14 OSProfile Mode

Table 1-19 shows the commands included in the OSProfile mode and their equivalent actions in the BUI.

Table 1-19 OSProfile Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning

import_jet_template

Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning> Create Profile> Select JET Template in the Subtype

import

Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Center Pane> Import Profile

export

Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Center Pane> Export Profile

clone

Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning> Center Pane> Copy Profile

delete

Navigation Pane> Plan Management> Profiles and Policies> OS Provisioning> Center Pane> Delete Profile

1.6.25.15 Reports Mode

Table 1-19 shows the commands included in the Reports mode and their equivalent actions in the BUI.

Table 1-20 Reports Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

show

NA

start

NA

stop

NA

list

NA

partition

NA

urns

NA

enable

NA

disable

NA

rollup

NA

cleanup

NA

info

NA

stats

NA

reset_stats

NA

pause

NA

reset

NA

delete

NA

1.6.25.16 ServerPools Mode

Table 1-24 shows the commands included in the ServerPools mode and their equivalent actions in the BUI.

Table 1-21 ServerPools Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list

Navigation Pane> Assets> Server Pools

list_members

Navigation Pane> Assets> Server Pools> Select a server pool

remove_members

Navigation Pane> Assets> Server Pools> Select a server pool> Select a server> Actions Pane> Remove from Server Pool

1.6.25.17 Update Mode

Table 1-22 shows the commands included in the Update mode and their equivalent actions in the BUI.

Table 1-22 Update Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list_policies

Navigation Pane> Plan Management> Profiles and Policies> Update Policies

list_profiles

Navigation Pane> Plan Management> Profiles and Policies> Update Profiles

list_distros

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Content tab> Search Criteria Menu> Distribution list

list_snapshots

NA

search_inventory

NA

check_inventory

NA

check_guus

NA

job_history

Navigation Pane> Assets> Select an asset> Jobs tab

get_job_status

Jobs Pane> Status column

load_kb_bundle

Navigation Pane> Administration> Enterprise Controller> Actions Pane> Setup Connection Mode

check_disconnected

Navigation Pane> Administration> Enterprise Controller> Actions Pane> Setup Connection Mode

set_connected_mode

Navigation Pane> Administration> Enterprise Controller> Actions Pane> Setup Connection Mode> Switch to Connected Mode or Switch to Disconnected Mode.

modify_gear

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> New Update OS Job

apply_profile_to_gear

Navigation Pane> Assets> All Assets> Select an asset> Actions Pane> New Update OS Job

create_historical_snapshot

NA

delete_snapshots

NA

create_profile

Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Actions Pane> New Profile

create_profile_from_inventory

NA

delete_profiles

Navigation Pane> Plan Management> Profiles and Policies> Update Profiles> Select a profile> Delete Profile

add_file_to_distro

NA

bulk_upload_directory

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Bulk Upload Packages

add_local_action

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Upload Local Action

add_local_category

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Add Local Category

delete_component

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Delete Local Component

add_configuration_file

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Upload Local Configuration

set_component_file

Navigation Pane> Libraries> Software Libraries> Linux, Solaris 8-10 Software Update Library> Actions Pane> Edit Local Component File

find_nodes

NA

1.6.25.18 User Mode

Table 1-23 shows the commands included in the User mode and their equivalent actions in the BUI.

Table 1-23 User Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

show_local_users

Navigation Pane> Administration> Enterprise Controller> Local Users

show_all_local_roles

Navigation Pane> Administration> Enterprise Controller> Local Users> Role Permission Mapping tab

show_local_user_roles

Navigation Pane> Administration> Enterprise Controller> Local Users

add_local_user

Navigation Pane> Administration> Enterprise Controller> Local Users > Actions Pane> Add User

grant_local_role

Navigation Pane> Administration> Enterprise Controller> Local Users> Manage User Roles icon

replicate_user_roles

Navigation Pane> Administration> Enterprise Controller> Local Users> Replicate User Roles icon

revoke_local_role

Navigation Pane> Administration> Enterprise Controller> Local Users> Manage User Roles icon

configureds

Navigation Pane> Administration> Enterprise Controller> Directory Serves> Add Directory Server

get_directory_servers

Navigation Pane> Administration> Enterprise Controller> Directory Serves>

get_ds_users

Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> User tab

sync_all_ds_users

Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> Actions Pane> Sync all remote users and roles

sync_ds_user

NA

remove_directory_service

Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> Delete Directory Server

delete_local_user

Navigation Pane> Administration> Enterprise Controller> Directory Serves> Select a Directory Server from the list> User tab> Select a user> Delete User

1.6.25.19 Virtualization Mode

Table 1-24 shows the commands included in the Virtualization mode and their equivalent actions in the BUI.

Table 1-24 Virtualization Mode Commands and Their Equivalent Actions in the BUI

CLI Command

BUI Action

list_hosts

Navigation Pane> Assets> All Assets> Servers

list_guests

Navigation Pane> Assets> All Assets> Servers

startup

Navigation Pane> Assets> All Assets> Select a non-global zone> Actions Pane> Migrate Zone

2 Man Pages for Enterprise Manager Ops Center

This chapter includes the following man commands:

- oc(5)

- certificates(1)

- collisions(1)

- controllers(1)

- credentials(1)

- deploy(1)

- deploy-setup(1)

- discover(1)

- fwimage(1)

- fwprofile(1)

- gear(1)

- groups(1)

- incidents(1)

- jobs(1)

- monitoring(1)

- networks(1)

- notifications(1)

- osimage(1)

- osprofile(1)

- reports(1)

- serverpools(1)

- stats(1)

- update(1)

- user(1)

- virtualization(1)

oc

Command to invoke the Enterprise Manager Ops Center.

Synopsis

oc
exit

Description

The Enterprise Manager Ops Center provides a set of modes to manage the Oracle Enterprise Manager Ops Center environment. Each mode has a set of subcommands to manage the objects controlled by the mode.

Type the oc command on a server's command-line to invoke the command-line interface. Type exit to stop the command-line interface and to return to the server's command-line. The first time that the CLI is started, files are compiled and cached, which causes a delay. Subsequent uses are not delayed.

To customize the command-line interface, use the setenv command. You can see the available options using the printenv command.

Commands for CLI Execution

connect [-h hostname] [-u username] [-p password|-p @filename][-n port][-a|--accept-all-certificates]

Authenticates the connection between Enterprise Manager Ops Center and the Enterprise Controller. The host is the system on which the Enterprise Controller is running. Use the -a| --accept-all-certificcates option to accept all certificates without receiving any confirmation message.

disconnect

Closes the connection between the Enterprise Manager Ops Center and the Enterprise Controller.

end

Terminates the mode and returns to the default command-line.

help [-l]

Displays usage information about the subcommands. The -l option includes detailed usage information.

ping

Checks connectivity to the Enterprise Controller.

printenv

Displays the user configuration.

record filename

Copies all console inputs and outputs to the file. Issue the command without a file name to stop the recording.

setenv

Sets the user environment in the following ways:

log_level
history_length integer
debug
pager
continue_on_error TRUE|FALSE
text_wrap_width integer
output_format=text|parsable

source filename

Specifies the file as the source of an operation when executing commands. Use this file for information that is shared by more than one script or to keep secure information separate from a script.

version

Displays the version of the CLI, the Oracle Enterprise Manager Ops Center software, the Java™ SE Runtime Environment, and the Java HotSpot™ Server VM software.

General Commands

The following commands can be used from within any mode at any time or from the main command-line.

history [-n number]

Lists the most recent commands. Use the -n option to limit the number of commands. The history includes a command number for the sequence. To repeat a command, enter the ! character with the command number and press the Tab key, as shown in the following example:

history -n 5
495 version
496 man history
497 help history
498 help -l history
#!495 <Tab>
#version

man modename

Displays the man page for the specified mode. The syntax and usage for all mode subcommands are included in the man page. To see a list of man pages, enter the command and press the Tab key.

wait [-i|--jobid jobID] [-r|--runid runID] [-a|--all] [-n|--maxwait max_wait]

Causes the CLI to wait until either the most recent job or the specified job finishes before executing the next command. You can identify a job by its jobID or by its runID. This command is used in scripts. To interrupt a wait operation interactively, press Ctrl+C.

Universal Output Filters

For any main or mode command, you can constrain the output by appending one of the following filters to the command:

- |grep regexp to filter by the regular expression.

- |countinteger to display only the number of output lines.

- |teefilename to write the output to a file.

For example, to create a file of jobs:

#localhost/jobs> list | tee /var/tmp/todays_jobs.txt

Mode Commands

The Enterprise Manager Ops Center provides a set of modes. Each mode operates on a type of object or performs a particular action. Within these modes, subcommands manage and control the actions of the mode. The subcommands of one mode do not operate in another mode.

The Enterprise Manager Ops Center supports the following modes:

- Certificates

- Collisions

- Controllers

- Credentials

- Deploy

- Deploy-setup

- Discover

- Fwimage

- Fwprofile

- Gear

- Groups

- Incidents

- Jobs

- Notifications

- Osimage

- Osprofile

- Stats

- Update

- User

- Virtualization

Command Scripts

For operations that are performed frequently, you can write scripts that enter modes, perform operations, and then exit modes. The following example shows a script named update.xvm that writes the inventory of the Finance server to a file. The command uses a password file, /tmp/p, which is identified by the its leading character, @.

connect finance_svr -u zz3282134 -p @tmp/p
update
csv_inventory -h finance_svr  -f ~/inventory_latest.csv
wait
end

To execute the file at any time, issue the following command:

oc < update.xvm

or

oc --cmdfile update.xvm

Within a script, you can use the source command to run another script that is external to your script.

To execute a subcommand of another mode, use its full command-line path:

notifications
cli.jobs.list

See Also

certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1)osimage(1) osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

certificates

Command to initiate the Certificates mode and to use its subcommands.

Synopsis

list [-a| --alias alias[,alias2,...,aliasn]] [-d|--detail]
add -h| --hostname EChostname -u| --username username [-p| --pass password] [-f| --force] [-n| --port portnumber]
remove -a|--alias alias[,alias2,...,aliasn]

Description

Certificates mode allows you to view and manage the list of trusted certificates for known remote EC servers. The CLI doesn't check for certificates in local connections.

Certificates are stored in a truststore file in the user directory. When connecting to an EC remotely, the CLI verifies if the certificate chain of the EC server is part of the trusted list. If the certificate chain is not in the trusted list, then the CLI request to accept the new certificate to add it to the list. If the certificate chain is not accepted, then the connection fails.

Additionally, you can set your user environment to silently accept all certificates by setting the accept_all_certificates variable to true, see the Oracle Enterprise Manager Ops Center Command Line Interface guide for more information in changing the value of the variable. You can also set your connection to silently accept all certificates by using the -a or --accept_all_certificates option with the connect command. This is especially useful for non-interactive sessions where it is not possible to interactively accept the certificate.

To enable your scripts to connect to a remote server, you can choose from the following options:

If you reinstall your EC and CLI often, modify your scripts to add the -a or --accept_all_certificates option to the connect command to make them pass-through.

If you reinstall your EC often but not the CLI, you might prefer to change the new CLI preference accept_all_certificates to automatically accept certificates at all times for all servers to which it connects. You can also add the following line at the beginning of each script to add the certificate, although this command connects to the EC and then disconnects: certificates.add -h hostname -u username [-n port] -p password -f.

If you do not reinstall your EC often, then you can connect to the EC interactively to accept the certificate at the user level which adds it to the user's truststore. In this case you will need to connect interactively to it after each reinstall of your EC to accept its new certificates.

SubCommands

list [-a|--alias alias[,alias2, ... , aliasN]] [-d|--detail]

Displays the alias, issuer, subject, and serial number. Use the -a|--alias option to display specific aliases. Use the -d|--detail option to include attributes for each alias.

add -h|--hostname hostname -u|--username username [-p|--pass password] [-f|--force] [-n|--port port_number]

Adds a certificate to the trusted list. User the -p|--pass option to execute the command without entering the user password interactively. Use the -f|--force option to execute the command without receiving any confirmation message, useful for scripts where no interaction is possible. Use the -n|--port option to specify a port number to use.

remove -a|--alias alias

Deletes a certificate from the trusted list.

Options

-a|--alias

Specifies that the subcomand acts on a specific alias.

-d|--detail

Includes certificates's attributes in the display.

-f|--force

Option to add a certificate to the trusted list without receiving any confirmation message, useful for scripts where no interaction is possible.

-h|--hostname

Option to specify the host name of the remote Enterprise Controller server.

-n|--port

Option to add a port number to use.

-p|--pass

Option to add a password to use.

-u|--username

Option to add the user name to use.

Operands

alias

The alias of the certificate.

password

Password of the user name to establish the connection to the remote Enterprise Controller server.

port_number

Port number to establish the connection to the remote Enterprise Controller server.

username

User name to establish the connection to the remote Enterprise Controller server.

Examples

Example 1   List the current accepted certificates

xvmSh/certificates > list
Alias        |            Issuer            |           Subject            | Serial Number |
---------------------------------------------------------------------------------------------------
root@sm-36:11172|    CN=sm-36_oem-ec_ca    |    CN=sm-36_oem-ec_ca    |   385822055
root@sm-36:11172|    CN=sm-36_oem-ec_ca    |  CN=sm-36_oem-ec_agent   |   1497938285

Example 2   To add a certificate for a server interactively

xvmSh/certificates > add -h sm-37 -u root
Enter password for authentication > ********
Untrusted certificate encountered. Create an exception to accept it at each connection? [Display/Yes/No] y
Certificate chain added for root@sm-37:11172

Example 3   Delete an accepted certificate

xvmSh/certificates > remove -a root@sm-37:11172
xvmSh/certificates>

See Also

oc(5), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

collisions

Command to detect and prevent collisions of MAC addresses or host IDs used by logical domains managed by Oracle Enterprise Manager Ops Center.

Synopsis

list -t|--type all|hostid|macaddress [-f|--file filename]
check -t|--type  -v|--values value[,value2,...,valueN]
allocate -n|--size number -r|--range manual|auto

Description

This module is about detecting collisions of host IDs and MAC addresses used by logical domains managed by Oracle Enterprise Manager Ops Center. A collision is an occurrence of a duplicated host ID or MAC address used by two or more logical domains.

You can run this command to detect host ID or MAC address collisions of logical domains existing in the Enterprise Controller.

This command also allows you to detect if specific host IDs or MAC addresses collide with host IDs or MAC addresses used by logical domains inside the Enterprise Controller. This functionality is specially useful to prevent collisions before adding logical domains created outside of Enterprise Manager Ops Center. You can either provide a file containing data of the logical domains or provide the host IDs or MAC addresses as part of the command.

Additionally, you can reserve a number of MAC addresses from a specified range. You can use the reserved MAC addresses to assign them to a future logical domain to guarantee it will not collide with other MAC address used inside the Enterprise Controller.

SubCommands

list -t|--type collision_type [-f|--file filename]

Lists all detected host ID or MAC address collisions of logical domains existing in the Enterprise Controller. Use the -f|--file option to provide data of logical domains to check them for possible collisions against host IDs or MAC addresses used by logical domains inside the Enterprise Controller.

You can run the script /opt/sun/n1gc/bin/read_mac on Oracle VM for SPARC control domains to collect their logical domains data. You can send the output of the script to a file and then use that file as part of the -f|--file option.

check -t|--type collision_type -v|--values value[value2,..valueN]

Verifies if the specified host IDs or MAC addresses collide with a host ID or MAC address used by logical domains inside the Enterprise Controller. This command identifies different level of collisions:

- Severe – For host ID collisions between two or more logical domains.

- Warning – For MAC address collisions between two or more vnets of logical domains, including alternate MAC addresses of the vnets.

- Info – For MAC address collisions between vnets of logical domains and logical domain MAC addresses.

allocate -n|--size number -r|--range manual|auto

Reserves a number MAC addresses from a MAC address network range. You can reserve MAC addressed from the manual or automatic range.

Options

-f|--file

Option to specify the name of the file containing the data of logical domains to detect possible collisions with host IDs and MAC addresses used by logical domains inside the Enterprise Controller.

-n|--size

Number of MAC addresses to reserve.

-r|--range

MAC address range from which a MAC addresses are reserved. Valid values are auto or manual.

-t|--type

Specifies the type of collisions to detect based on host ID, MAC address, or both.

-v|--value

List of host IDs or MAC addresses to check for collisions.

Operands

collision_type

The type of collision to detect. When used with the list command, valid values are all, hostid, and macaddress. If used with the check command, valid values are hostid or macaddress.

filename

Name of the file containing the logical domains data for detecting possible collisions with MAC addresses or host IDs used by logical domains inside the Enterprise Controller.

You can run the script /opt/sun/n1gc/bin/read_mac on Oracle VM for SPARC control domains to collect their logical domains data and send the output of the script to a file, then use that file as part of the -f|--file option of the list command.

The following is an example of the file:

# cat /tmp/dumpldom.txt
14b2d04d-01e0-cec0-e1ef-85152b04d749.primary.uuid=14b2d04d-01e0-cec0-e1ef-85152b04d749
14b2d04d-01e0-cec0-e1ef-85152b04d749.primary.domainname=primary
14b2d04d-01e0-cec0-e1ef-85152b04d749.primary.hostid=0x8620d46a
14b2d04d-01e0-cec0-e1ef-85152b04d749.primary.domainmacaddress=00:10:e0:20:d4:6a
14b2d04d-01e0-cec0-e1ef-85152b04d749.primary.macaddresses=00:14:4f:f9:65:c9,00:14:4f:fa:3d:bf,00:14:4f:f8:02:15,00:14:4f:f8:94:9b
14b2d04d-01e0-cec0-e1ef-85152b04d749.primary.server=xvmt-3-n123
1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2.guest-1.uuid=1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2
1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2.guest-1.domainname=guest-1
1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2.guest-1.hostid=0x84f9ca04
1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2.guest-1.domainmacaddress=00:14:4f:f9:ca:04
1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2.guest-1.macaddresses=00:14:4f:fa:c9:13,00:14:4f:f9:a1:9b
1e9b224b-0f8f-cbfb-ce28-dd6601fdb3d2.guest-1.server=xvmt-3-n123

number

Number of MAC addresses to reserve.

range_pool

Type of the pool range from which the MAC addresses are reserved. Valid values are auto and manual.

value

Host IDs or MAC addresses for detecting possible collisions against them.

Examples

Example 1   Verify if collisions exist for the host IDs specified in the file

xvmSh/collisions > list -t hostid -f ./dumpldoms.txt
Collision on hostid 84ffb4b4  :
server         |  name     |               UUID                 |        MAC   |
----------------------------------------------------------------------------------
foo.example.com|ldom_guest |a2478fdd-62f8-c4af-afdd-e2d93cc93abb|00:14:4F:FB:5D:0E
foo.example.com|guest-inte |544fe468-90a8-66ce-990f-bb4b79842fa9|00:14:4F:FA:2D:E1
foo.example.com|ldom_guest1|7db50419-d46d-4351-b7f7-ba7d5f1c76fd|00:14:4F:FF:B4:B4

Example 2   Verify if collisions exist for the specific MAC addresses

xvmSh/collisions > check -t maccaddress -v 0:14:4F:FB:5D:0E,00:14:4F:FA:2D:E1
Collision Level - INFO :
server        | name        |                  UUID            |    MAC         |
----------------------------------------------------------------------------------
foo.example.com|ldom_guest |a2478fdd-62f8-c4af-afdd-e2d93cc93abb|00:14:4F:FB:5D:0E
foo.example.com|ldom_guest2|3c526eeb-f38c-c169-ed1c-88a0825e7a38|00:14:4F:FB:5D:0E

Example 3   Reserve two MAC addresses

xvmSh/collisions > allocate -n 2 -range manual
Allocated MAC addresses:
MAC Address       |
--------------------------
00:14:4F:FD:5C:AD
00:14:4F:FF:05:E5

See Also

oc(5), certificates(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

controllers

Command to initiate the Controllers mode and to use its subcommands.

Synopsis

list
migrate_assets -U|--UUID proxy_uuid

Description

The Controllers mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use the Controllers subcommands to migrates the assets managed by a Proxy Controller to another Proxy Controller.

Type the controllers command at the command line prompt to enter Controllers mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list

Displays a list of the available Proxy Controllers, Enterprise Controllers, and Virtualization Controllers.

migrate_assets -U|-UUID proxy_uuid

Migrates the assets managed by a Proxy Controller to another available Proxy Controller.

Options

-U|--UUID

Specifies a Proxy Controller by its Universal Unique Identifier

Operands

proxy_uuid

Universal Unique Identifier, to distinguish a specific Proxy Controller form one with the same asset name.

Examples

Example 1   Displays the available Proxy Controllers

localhost/controllers > list
Controller list:
Name        |                 UUID                 |Status |   Version   |
-----------------------------------------------------------------------------
192.0.2.95-PC     | h4fm76fd-28be-4892-8uae-4i8b20b780e1 |UNKNOWN| 12.1.4.2311 |
192.0.2.97-PC     | 6485cdab-7654-ac6b-a781-4fg796791054 |   OK  | 12.1.4.2311 |
192.0.2.97-EC     | abcd2f30-ef67-4564-ab12-bc989b6ab671 |   OK  | 12.1.4.2311 |
x44-sa1-VC        | 987me955-1edt-4678-adi5-192ggg1e74e6 |   OK  | 12.1.4.2311 |

Example 2   Migrates the assets from a Proxy Controller to another Proxy Controller

localhost/controllers > migrate_assets -U h4fm76fd-28be-4892-8uae-4i8b20b780e1

See Also

oc(5), certificates(1), collisions(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

credentials

Command to initiate the Credentials mode and to use its subcommands.

Synopsis

list [-i|--ids credentialID[,credentialID2,...,credentialIDn]] [-l|--detail]
modify -i|--id credentialID

Description

The Credentials mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use the Credential subcommands to view and change the credentials used to discover and manage an asset. Credentials also establish trust relationships between components of the product.

Type the credentials command at the command line prompt to enter Credentials mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list [-i|--ids credentialID[,credentialID2, ... , credentialIDn]] [-l|--detail]

Displays the credential ID, the name of the credential, its type, and a description. Use the -l|--detail option to include attributes for each credential such as role, port, and timeout value. You can limit the number of displayed credentials by using the -i|--ids option to specify one or more credential IDs.

EnterpriseController/credentials> list
ID |        Name      |  Type        |  Description
----------------------------------------------------
2213 | CERTIF_cred     | CERTIFICATE   | text entered at creation
2210 | CISCO_cred      | CISCO_IOS     | Location3 switch
2215 | CHAP_cred       | CHAP          | text
2206 | HTTP_name       | HTTP          | text
2204 | IPMI_cred       | IPMI          | text
2209 | JMX_cred        | JMX           | text
2211 | OVM_manage_cred | OVM           | text
2212 | OVM_serv_cred   | OVM           | text
2205 | SNMP_           | SNMP          | text
2201 | SSH_cred        | SSH           | text
2214 | STORAGE_cred    | STORAGE_ADMIN | text

modify -i|--id credentialID

Starts a submode with its own set of commands to view and change the attributes of a specific credential.

EnterpriseController/credentials> modify -i 2210
EnterpriseController/credentials/modify>

show

Displays a list of all properties and their current values. Any property that starts with an asterisk character is mandatory and cannot have a value of None.

description=Location3 switch
admin=*****
username=CISCO_user
login=*****
community=*****

reset

Changes the value of all properties to their default values or, for properties with no default value, to None.

unset property

Changes the value of the specified property to its default value or, if there is no default value, to None.

set property=value

Provides a new value for the specified property.

commit

Submits a job to change the attributes of the credential.

Options

-i

- With the list command, this option can also be invoked as --ids.

- With the modify command, this option can also be invoked as --id.

-l|--detail

Includes credential's attributes in the display.

Operands

credentialID

The numeric identifier for a specific credential.

property

The characteristic of a credential that, together with the property's value, comprise an attribute of a credential for an asset, as displayed by the modify> show command.

value

The specification of a credential's property.

Examples

Example 1   To change the port used by Credential 6850 to Port 23:

EnterpriseController/credentials > modify -i 6850
EnterpriseController/credentials/modify > set port=23
EnterpriseController/credentials/modify > commit
EnterpriseController/credentials/modify > end
EnterpriseController/credentials >
Credential data for 6850 has been modified

See Also

oc(5), certificates(1), collisions(1), controllers(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

deploy

Command to initiate the Deploy mode and to use its subcommands.

Synopsis

add "attribute={string|integer|true|false}[, attribute2...attributen]"
apply
dryrun
set "attribute={string|integer|true|false}[, attribute2...attributen]"
show [plan|results]

Description

The Deploy mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Deploy subcommands to specify the attributes of a deployment plan and then to deploy the plan on target assets. You can modify the plan before you apply it; however, your changes are not saved and no new version of the plan is created.

The Deploy mode requires that you first specify a plan and at least one target in Deploy_setup mode. To enter Deploy mode, type deploy command. The command line prompt indicates that you are in Deploy_setup mode. After you specify a plan and a target, the command line prompt changes to Deploy mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

add "attribute={string|integer|true|false}"

add "attribute={list of subattributes}"

add "@assetname1:attribute1={string|integer|true|false}"

Includes a new attribute in the deployment plan as a key-value pair. Attributes depend on the type of deployment plan.

apply

Executes the deployment plan on the target assets. Some types of deployment plans or targets require that you set an attribute before you can apply the plan.

- Configure M-Series Hardware, Create and Install Domain- None.

- Configure RAID - None.

- Configure Server Hardware and Install OS - None.

- Configure Service Processor - None.

- Configure and Install Dynamic System Domain - None.

- Configure and Install Logical Domains - None.

- Configure and Install Virtual Machines - None.

- Create Boot Environment - None.

- Create Dynamic System Domain - None.

- Create Logical Domains - For each logical domain: set and add prime, set and add guestName.

- Create Zones - For each zone: set and add prime, set and add IP mode, set and add IP address if mode is static, set and add ifName to identify the NIC, set and add hostname.

- Configure and Install Solaris Zones - For each zone: set and add prime, set and add IP mode, set and add IP address if mode is static, set and add ifName to identify the NIC, set and add hostname.

- Create Virtual Machines - None.

- Provision Network - None.

- Provision OS - Set the IP address, set dataIp if IPMP option is selected in the OS provision profile.

- Install Server - Set the IP address, set dataIp if IPMP option is selected in the OS provision profile.

- Software Deployment / Update - None.

- Update Oracle Solaris 11 OS - None.

- Update BIOS - None.

- Update Firmware – None.

- Update Firmware and Install Oracle VM Server for SPARC - None.

dryrun

Simulates the deployment. Creates the tasks of the job but does not submit the job.

set "attribute={string|integer|true|false}[,attribute2,...attributen]"

set "attribute={list of subattributes}"

set "@assetname1:attribute1={string|integer|true|false}"

Changes the value of every occurrence of an attribute in the plan. A simple attribute is a key-value pair. To see the current attributes, use show plan subcommand.

show [plan|results]

Displays information about the current plan. With no options, the command lists the structure of the deployment plan. With the plan option, the subcommand displays the attributes of the deployment plan. With the results option, the subcommand reports the result of the plan.

Options

plan

Displays the attributes of the deployment plan. Adds an asset or a list of assets to the current targets of the plan.

results

Displays the result of the deployment plan.

Operands

attribute

A simple attribute is a key-value pair. An attribute that is backed by other objects is represented as a list of key-value pairs. To see the current attributes, use show plan subcommand. If you prefer, you can set a new value for an attribute as a JSON string.

Examples

Example 1   Execute the firmware deployment plan on two servers: the selected target and a new target, with a forced reinstallation on the second target.

EnterpriseController/deploy > show plan
Target: foo.example.com
--------------------------------------------------   Step: Update Firmware -----------------------------------------------------       Associated Profile:        { firmwarePackages: [ ILOM-3_0_3_31_a-Sun_Fire_X4600M2 ] dryRun: False subType: Server resetSP: False profileDescription: Updates ILOM firmware forceDowngrade: False forceReinstall: False profileName: fwp network: None ip:None }
EnterpriseController/deploy_setup > target -a foo2.example.com
EnterpriseController/deploy > add "foo2.example.com:forceReinstall=true"
EnterpriseController/deploy > dryrun
xxx example xxx
EnterpriseController/deploy > apply

Example 2   Provisions an OS for the target foo.example.com

EnterpriseController/deploy > show plan
Target: foo.example.com
--------------------------------------------------   Step: Provision OS -----------------------------------------------------       Associated Profile:        { OSPackages: [ <examples> ] dryRun: False subType: Server resetSP: False profileDescription: Updates ILOM firmware forceDowngrade: False forceReinstall: False profileName: osp network: None ip:None }
EnterpriseController/deploy > set "ip=192.0.2.10"
EnterpriseController/deploy > show plan"
Target: foo.example.com
--------------------------------------------------   Step: Provision OS -----------------------------------------------------       Associated Profile:        { OSPackages: [ <xxxxexamples> ] dryRun: False subType: Server resetSP: False profileDescription: Updates ILOM firmware forceDowngrade: False forceReinstall: False profileName: osp network: xxx ip:192.0.2.10 }
EnterpriseController/deploy > apply

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

deploy-setup

Command to initiate the Deploy-setup mode and to use its subcommands.

Synopsis

plan [-v|--version version] plan_name
target [-a|--add] [-d|--delete] [-g|--gear] [-U|--UUID] assetname1[,assetname2...assetnamen]

Description

The Deploy-setup mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Deploy-setup subcommands to identify the deployment plan and target assets.

Type the deploy-setup command at the command line prompt to enter the mode. When you have completed the requirements of the Deploy-Setup mode, the mode changes to the Deploy mode so that you can test or apply the plan. Type the end to stop the mode and to return to the command line prompt.

Subcommands

plan [-v|--version version] plan_name

Identifies the plan you want to view, modify, or apply. The plan must be created through the browser interface. If more than one version of the plan exists, you can specify the version.

target [-a|--add] [-d|--delete] [-g|--gear] [-U|--UUID] assetname[,assetname2...assetnamen]

Identifies the managed assets for the plan. After you use this subcommand, you can change the current list of targets by adding or deleting assets.

Options

-a|--add

Adds an asset or a list of assets to the current targets of the plan.

-d|--delete

Removes an asset or a list of assets from the current targets of the plan.

-g|--gear

Identifies the assets by their User Friendly Name.

-U|--UUID

Identifies the assets by their public Unique Universal ID.

-v|--version

Identifies an earlier version of the current deployment plan.

Operands

plan_name

The name of an existing deployment plan. By default, the most recent version of the plan is used. To see a list of plans, use the browser interface.

assetname

The UUID or UFN (User Friendly Name) of the target asset or a comma-separated list of assets. To obtain an asset's UUID, use the gear mode's list subcommand or use the browser interface's Dashboard Summary for the asset.

version

Integer

Examples

Example 1   Specify the deployment plan and the targets of the plan.

EnterpriseController/deploy-setup> plan ospS10_dplan
Plan "ospS10_dplan" selected: version 1, description "Install Oracle Solaris 10"
EnterpriseController/deploy-setup> target foo.example.com
EnterpriseController/deploy>

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), discover(1), fwimage(1). fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

discover

Command to initiate the Discover mode and to use its subcommands.

Synopsis

create
end
execute -i|--id profile_ID -t|--targets UFN[,UFN2,...UFNn] [-n|--networkuuid UUID] [-c|--credentials credentialID[,credentialID2,...,credentialIDn]] [-r|--ranges discovery_ranges_ID[,discovery_ranges_ID2,...,discovery_ranges_IDn]] [-m|--management management_credential_ID] [-s|--serviceTag servicetag_credential_ID] [-a|--agentLess]
list_credentials [-i|--ids credentialID]
list_networks
list_profiles [-i|--ids profile_ID]
list_profile_credentials -i|--id profile_ID
list_profile_ranges -i|--id profile_ID
list_ranges [-i|--ids ipaddress_spec]

Description

The Discover mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use the Discover subcommands to create jobs that retrieve information about the following types of assets.

- Oracle Solaris or Linux operating system (OS)

- Microsoft Windows OS

- ILOM server processor

- ALOM service processor

- ELOM service processor

- IPMI service processor

- RSC service processor

- Oracle Solaris Cluster node

- Sun ZFS Storage Appliance

- V20z and V40z service processor

- XSCF service processor

- All types

Type the discover command at the command line prompt to enter Discover mode. Type the end command to stop the mode and to return to the command line prompt. You can discover assets by using either the create subcommand or, if you have discovery profiles, the execute subcommand.

Use the create subcommand begin a discovery job. A discover job consists of specifications for the search and credentials for access to the assets. The specifications needed for a discovery job depend on the type of asset to be discovered. Before you create a discovery job, use the show --type command to see the list of supported asset types. Use the show --type command again with an asset type to see the list of requirements to discover that type of asset. Then use the set subcommands to define the attributes and actions of the discovery job. Submit the discover job with the commit command.

As an alternative, you can use existing discovery profiles to locate and identify assets that match the attributes of a discovery profile. In this case, the execute starts a job that uses the discovery profile.

Subcommands

create

Starts the process of defining a new discover job. This command starts a submode with its own subcommands for specifying the attributes and actions of the job and to manage the job. Issue the set type subcommand to specify the type of asset. The type determines the other set subcommands needed to complete the specifications for the discovery job.

set type=type

Specifies the requirements for the discovery job. Issue this subcommand first and then issue the show subcommand to see the required subcommands for that type of asset.

set ssh_user=username

Specifies the name for an account to the ssh utility.

set ssh_password=password

Provides the password for the ssh account.

set ssh_root_user=username

(Optional) Specifies the name of a user account with root access to the ssh utility.

set ssh_root_password=password

(Optional) Provides the password for the root account for the ssh utility.

set ipaddrs=ipaddress

(Optional) Specifies the target IP address or addresses.

set ssh_port=portnumber

Specifies the port used by the ssh utility.

set use_default=true|false

Specifies that the factory default credentials are used for the discovery job.

set ipmi_user=username

Specifies the name of an Intelligent Platform Management Interface (IPMI) account, required for ILOM and ALOM discovery jobs.

set ipmi_password=password

Provides the password for the Intelligent Platform Management Interface (IPMI) account, required for ILOM and ALOM discovery jobs.

set telnet_user=username

Specifies the name for an account to the telnet utility, required to discover assets with ALOM service processors.

set telnet_password=password

Provides the password for the telnet account.

set jmx_user=username

Specifies the name of an JMX account

set jmx_password=password

Provides the password for the JMX account.

set snmp_user=username

Specifies the name of the account for the SNMP utility.

set snmp_community_string=string

Provides a non-private password for early versions of the SNMP

set snmpv3_user=username

Specifies the name of the account for the SNMP Version 3 utility.

set snmpv3_password=password

Provides the password for the SNMP Version 3 account.

set wmi_user=username

Specifies the name of the account for the Microsoft Windows Management Interface utility.

set wmi_password=password

Provides the password for the Microsoft Windows Management Interface account.

show [-t|--types]

Before a type of asset is specified, this command lists the supported types. After the set type subcommand has been issued, this command lists the required subcommands for the specified asset type.

clear

Cancels the settings you have entered for the discovery job before you submit it.

unset

Uses the same properties as the set subcommand to cancel the definition.

commit

Submits the discover job. Issue this command after you have specified the discovery job.

end
Stops the submode and returns to the Discover mode.

execute -i|--id profile_ID -t|--targets UFN[,UFN2,...UFNn] [-n|--networkuuid UUID] [-c|--credentials credentialID[,credentialID2,...,credentialIDn]] [-r|--ranges discovery_ranges_ID[,discovery_ranges_ID2,...,discovery_ranges_IDn]] [-m|--management management_credential_ID] [-s|--serviceTag servicetag_credential_ID] [-a|--agentLess]
Specifies a new discover job, using a discovery profile. The discovery profile must already exist. In addition to the profile, this command uses information you provide such as target names, network identifiers, credentials for access, service tags, or ranges of IP addresses.

list_credentials [-i|--ids credentialID]
Displays a list of credential identifiers to be used to get access to assets to complete their discovery. The account and password credential are not displayed. To see detailed information about a credential, add the -i option.

list_networks
Displays a list of networks that include a Proxy Controller. You can probe these networks for targets to discover.

list_profiles [-i|--ids profile_ID]
Displays a list of existing discovery profiles. To see detailed information about one profile, add the -i option with the name of the discovery profile.

list_profile_credentials -i|--id profile_ID
Displays the credential identifiers included in the discovery profile you specify.

list_profile_ranges -i|--id profile_ID
Displays the ranges included in the discovery profile you specify.

list_ranges [-i|--ids ipaddress_spec]
Displays a list of IP ranges to be probed. To see detailed information about one network range, add the -i option with the name of the range.

Options

-a|--agentLess

Manages the discovered target, without installing an agent.

-c|--credentials

Specifies the identifier for the set of credentials needed to get access to target assets.

-i

- With the execute, list_profiles, and list_profile_ranges commands, this option identifies one or more discovery profiles. This option can also be invoked as --ids with the execute command, and as --id with the list_profiles and list_profiles_ranges commands.

- With the list_credentials command, this option identifies one or more driver credentials. This option can also be invoked as --ids.

- With the list_ranges command, this option identifies one or more network ranges. This option can also be invoked as --ids.

-m|--management

Specifies the identifier for the set of management credentials needed to get access to target assets.

-n|--networkuuid

Identifies one or more networks.

-r|--ranges

Identifies the range of networks to be probed for targets that comply with the discovery profile.

-s|--serviceTag

Identifies service credentials needed to get access to targets to complete the discovery of the targets.

-t

- With the execute command, this option specifies one or more targets to be probed for discovery. This option can also be invoked as --targets.

- With other commands, this option lists the required settings for the type of asset that has been set.

Operands

The following operands are supported:

credentialID

Numeric string that retrieves the public and private credential for systems to be discovered.

discovery_ranges_ID

Numeric string that identifies a network range.

ipaddress_spec

For list_ranges subcommand, a range of IP addresses.

For set ipaddrs subcommand, a name of a host, a single IP address in CIDR subnet notation, a comma-separated list of IP addresses enclosed with parentheses, a range of IP addresses, or a group of IP addresses included by a mask

- hostname

- ipaddress

- (ipaddress1,ipaddress2,...ipaddressn)

- low_ipaddress-high_ipaddress

- low_ipaddress/high_ipaddress

- ipaddress1/n

management_credential_ID

Numeric string that identifies a management credential.

password

String that acts as the private credential for an account.

profile_ID

String that identifies the profile, not the name of the profile. Use the list_profiles subcommand to see a table of profile identifiers and profile names.

servicetag_credential_ID

Numeric string that identifies a service tag credential.

type

Type of asset discovered by the job. Valid values are:

- all to discover every type of asset

- alom to discover ALOM service processors

- elom to discover ELOM service processors

- ilom to discover ILOM service processors

- ipmi to discover IPMI service processors

- os to discover Linux and Oracle Solaris operating systems

- rsc to discover RSC servicce processors

- sc to discover Oracle Solaris Cluster nodes

- ss7k to discover Sun ZFS Storage Appliances

- v2xz to discover V20z or V40z service processors

- windows to discover Microsoft Windows operating systems

- xscf to discover XSCF service processors

UFN

User-Friendly Name of a system.

UUID

Universal Unique Identifier for a network.

username

Public identifier for an account.

Examples

Example 1   Create and start a job that locates operating systems within a range of IP addresses

EnterpriseController > discover
EnterpriseController/discover > create
EnterpriseController/discover/create > set type=os
EnterpriseController/discover/create > set ssh_user=pat
EnterpriseController/discover/create > set ssh_password=secret99
EnterpriseController/discover/create > set ipaddrs=192.0.2.0/24
EnterpriseController/discover/create > commit
Discovery job submitted - Job ID = hs-x4100-1.65

Example 2   Execute a job that uses the discovery profile geoX to discover and manage servers agentlessly within a range of IP addresses.

EnterpriseController > discover
EnterpriseController/discover > execute -i geoX -t occos-o780-06 -a -m 2050
Using Default Driver Credentials set [GeoX]
Management Credentials set [GeoX]
Management Mode: agentless
Job: localhost 7 was created using Discovery Profile ID: GeoX for discovery

Example 3   Create and start a job that locates service processors for other types of assets within a range of IP addresses

EnterpriseController > discover
EnterpriseController/discover > create
EnterpriseController/discover/create > set type=alom
EnterpriseController/discover/create > set ssh_user=pat
EnterpriseController/discover/create > set ssh_password=secret99
EnterpriseController/discover/create > set ipmi_user=pet
EnterpriseController/discover/create > set ipmi_password=secret01
EnterpriseController/discover/create > set telnet_user=pit
EnterpriseController/discover/create > set telnet_password=secret10
EnterpriseController/discover/create > set ipaddrs=192.0.2.0 - 192.0.2.24
EnterpriseController/discover/create > commit
Discovery job submitted - Job ID = hs-x4100-1.66

Example 4   To see a list of discovery profiles

EnterpriseController/discover > list_profiles
Discovery Profiles
ID  |    Name              |       Type
----------------------------------------------------
GeoX  | Discovery Profile    |  SolarisLinuxOS

See Also

oc(5), certificates(1), collisions(1), controllers(1), discover(1), deploy(1), deploy-setup(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

fwimage

Command to initiate the Fwimage mode and to use its subcommands.

Synopsis

create
delete -i|--image imagename
list [-l|--detail]
update -i|--image imagename

Description

The Fwimage mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Fwimage subcommands to create and manage firmware image packages.

Type the fwimage command at the command line prompt to enter Fwimage mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list [-l|--detail]

Displays a list of all firmware images managed by Oracle Enterprise Manager Ops Center. Use this command to obtain the name for a specific image. Add the -l|--detail option to the command to display detailed information about the firmware image packages.

create

Starts a submode that uses subcommands to define a new firmware image. Use the following set commands to specify a new firmware image.

set name=imagename
set version=version
set type=type
set make=manufacturer
set url=None|URL
(Optional) set description=None|text
(Optional) set size=0|size
(Optional) set powerOffRequired=True|False
(Optional) set dependeeFirmwarePackageName=None|packagename
(Optional) set updateCount=count
show displays the definition of the create job.
unset uses the same properties as the set subcommand to cancel the definition.
reset cancels all properties defined with the set subcommand
commit starts the create job.
add_device -v|--vendor vendor -m|--model model [-V|--validated]

delete -i|--image imagename

Removes a firmware image package from Oracle Enterprise Manager Ops Center management. The package must not be in use by any host.

update -i|--image imagename

Starts a submode that uses subcommands to update an existing firmware image package. Use the set command to change the attributes of the package. Use the commit command to run the update job.

Options

-l|--detail

Specifies that the output of the list subcommand includes the additional information.

-m|--model

Specifies the model of a device.

-i|--image

Specifies that the subcommand acts on a specific image.

-v|--vendor

Specifies the vendor of a device.

--V|validated

Specifies that the new firmware image is validated.

Operands

count

The number of times that the firmware image package has been updated.

packagename

Identifies whether the new image package requires other packages and if so, the names of the packages. Valid values are None, the name of a package, or a comma-separated list of packages.

description

Text that identifies the image.

device

Specifies one or more devices supported by the firmware. Use a comma-separated list to include more than one device.

manufacturer

The identifier of the manufacturer of a new image.

model

The model of the device for the firmware image.

imagename

The identifier of a specific image package.

size

The maximum size of the new image package. The default size is 0.

type

The identifier for the category of firmware, for example ”disk.”

URL

The Uniform Resource Locator that identifies where the new image package is located.

vendor

The vendor of the device for the firmware image.

version

The identifier of the version of the new image package.

Examples

Example 1   Display a detailed list of images

EnterpriseController/fwimage > list -l

Example 2   Remove an image.

EnterpriseController/fwimage > delete -i SUNWmms

Example 3   Create an image package with a new device

EnterpriseController/fwimage > create
EnterpriseController/fwimage/create > set name=fwpkg
EnterpriseController/fwimage/create > set url=domain/path/directory
EnterpriseController/fwimage/create > set version=0.1
EnterpriseController/fwimage/create > set make=Sun
EnterpriseController/fwimage/create > add_device -v Sun -m Netra 240 Server --validated
EnterpriseController/fwimage/create > set device
EnterpriseController/fwimage/create > set type=System-Firmware
EnterpriseController/fwimage/create > commit
Firmware image created successfully
EnterpriseController/fwimage/create > end

Example 4   Update an existing image with a new version and type

EnterpriseController/fwimage > update -i fwpkg
EnterpriseController/fwimage/update > set version=0.2
EnterpriseController/fwimage/update > set description="New support for Netra 240"
EnterpriseController/fwimage/update > commit
Firmware image created successfully
EnterpriseController/fwimage/update > end

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

fwprofile

Command to initiate the Fwprofile mode and to use its subcommands.

Synopsis

create -p|--profile profilename -i|--images image1[,image2...imagen] [-d|--description description] [-r|--reinstall] [-g|--downgrade]
delete -p|--profile profilename
list [-l|--detail]
status -p|--profile profilename]
update -p|--profile profilename -i|--images image1[,image2...imagen] [-d|--description description] [-r|--reinstall] [-g|--downgrade]

Description

The Fwprofile mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Fwprofile subcommands to manage the firmware profiles that are used to provision assets with firmware images.

Type the fwprofile command at the command line prompt to enter Firmware mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

create -p|--profile profile_name -i|--images image1[,image2...imagen] [-d|--description description] [r|--reinstall] [-g|--downgrade]

Creates a new firmware profile to provision assets that specifies one or more firmware images. You have the option to force a reboot or a downgrade.

list [-l|--detail]

Displays a list of all firmware profiles managed by Enterprise Manager Ops Center. Use this command to obtain the name for a specific profile. The -l|--detail provides details about the profile.

delete -p|--profile profile_name

Removes a profile.

status -p|--profile profile_name

Displays the current state of a profile.

update -p|--profile profile_name -i|--images image1[,image2...imagen] [-d|--description description [-r|--reinstall] [-g|--downgrade]

Changes an existing firmware profile.

Options

-d|--description

Describes the specified profile.

-g|--downgrade

Specifies that the image is installed even if current version on the asset is higher that the image in the profile.

-i|--images

Specifies one or more firmware images in a comma-separated list.

-l|--detail

Displays detailed information.

-p|--profile

Identifies the firmware profile.

-r|--reinstall

Specifies that an image is installed even if the version is the same.

Operands

image

The identifier of a firmware package. A profile has at least one image. For more than one image, use a comma-separated list.

profilename

The identifier of a specific profile. To obtain a profile name, use the list subcommand.

description

A string that specifies the purpose of the profile.

Examples

Example 1   Remove a profile

EnterpriseController/fwprofile > delete -p prof_weekly

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

gear

Command to initiate the Gear mode and to use its subcommands. The Gear subcommands view and manage individual operating systems, hardware, and chassis.

Synopsis

apply_firmware -g|--gear assetname [-U|--UUID assetuuid] -p|--profile profilename
delete -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist][-f|--force]
fwprofile_compliance -g|--gear assetname[,assetname2...assetnamen] -p|--profile profilename
list [-l|--detail] [-f|--filter search_string]
manage -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] -u|--user username -p|--password password [-t|--type=type]
poweroff -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-f|--force]
poweron -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist]
provision_os -g|--gear assetname -p|--profile profilename
reboot -g|--gear assetname [-U|--UUID assetuuid ] [--attributes=attributelist]
refresh -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist]
reinstall_agent -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] -u|--user username [-p|--password password] -v|--version version
reset -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-n|--netboot] [-f|--force[
set -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-l|--locator on|off] [-n|--notifications on|off]
set_maintenance -g|--gear [-U|--UUID assetuuid] [--attributes=attributelist] on|off
show_jobs -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist]
unmanage -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] -u|--user username -p|--password password  [-t|--type=type]
update -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-d|--description text] [-n|--name new_assetname] [-t|--tags text] [-s|--semantictags text]

Description

The Gear mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Gear subcommands to view and manage assets including operating systems, hardware, and chassis.

Type the gear command at the command line prompt to enter Gear mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

apply_firmware -g|--gear assetname [-U|--UUID assetuuid] -p|--profile profilename

Provisions assets with the packages described in a firmware profile.

delete -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-f|--force]

Remove the specified asset from Oracle Enterprise Manager Ops Center's management.

fwprofile_compliance -g|--gear assetname[,assetname2...assetnamen] -p|--profile profilename

Determines whether the specified assets comply with the images and policies in the specified profile.

list [-l|--detail] [-f|--filter search_string]

Displays a list of all operating systems, servers, and chassis that are managed by Oracle Enterprise Manager Ops Center. Use this command to obtain the name of an asset to use with the other Gear subcommands, either its User Friendly Name or its UUID. Add the -l option to include detailed information about the asset. Use the -f|--filter option with a regular expression to control the contents of the list.

manage -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] -u|--user username -p|--password password [-t|--type=type]

Includes the specified asset as one of Oracle Enterprise Manager Ops Center's managed assets.

poweroff -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-f|--force]

Deactivates a managed server or chassis. Use the poweron command to activate the asset.

poweron -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist]

Activates a managed server or chassis.

provision_os -g|--gear assetname -p|--profile profilename

Maintains an operating system on a single server. The command starts a submode with its own commands for defining the provisioning job. In addition to the set subcommand, you can use the same attributes with the show subcommand to see the current value and you can use them with the unset subcommand to cancel any value you have set. The following submode commands are required:

set profile=profilename identifies the provisioning profile for an operating system.
set system_type=os_type identifies the type of operating system: solaris, redhat, or suse.
set server_name=servername identifies the server running the operating system.
set hostname=hostname identifies the name for the operating system.
set ip_address=ipaddress identifies the IP address of the operating system.
commit submits the provisioning job.
The following submode commands are optional:

set register=True|False controls whether to add the information to the inventory.
set manualnetboot=True|False controls whether to allow the use of netboot.
set domain= company.com defines the route for locating the operating system.
set netmask= ipaddress defines the route for locating the operating system.
set gateway= ipaddress defines the route of the operating system.
set nameserver= ipaddress defines the route for locating the operating system.
set boot_path= path identifies the path to the device for starting the operating system.
set boot_device= devicename identifies the device for starting of the operating system
set console_baud= baudrate identifies the console's baud rate. Default is 9600.
set console= consoletype identifies the console's type. Default is ttya

reboot -g|--gear assetname [-U|--UUID assetuuid] [--attributes=attributelist]

Reboots an operating system.

refresh -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist]

Updates the asset's information by re-probing the component, including scanning the service tag.

reinstall_agent -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] -u|--user username [-p|--password password] -v|--version version

Re-installs agent software on the specified asset.

reset -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-n|--netboot] [-f|--force]

Resets hardware, either a server or chassis, by powering it off and then powering it on.

set -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-l|--locator on|off] [-n|--notifications on|off]

Controls the actions of specific asset. Use the subcommand to control the asset's locator lights and whether it uses notifications.

set_maintenance -g|--gear [-U|--UUID assetuuid] [--attributes=attributelist] on|off

Places an asset in maintenance mode or removes an asset from maintenance mode.

show_jobs -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist]

Lists the jobs associated with the specified asset. This subcommand gives the same result as the Jobs mode's list --filter assetname command.

unmanage -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] -u|--user username -p|--password password [-t|--type=type]

Releases the specified asset from Oracle Enterprise Manager Ops Center management and uninstalls the agent software.

update -g|--gear assetname[,assetname2...assetnamen] [-U|--UUID assetuuid] [--attributes=attributelist] [-d|--description text] [-n|--name new_assetname] [-t|--tags text] [-s|--semantictags text]

Changes attributes of a specific asset. Use the subcommand to change the name of the asset, add or change a description of the asset, and add or change a tag.

Options

-d|--description

Adds or changes the description of a specific asset.

-f

- With the list subcommand, this option accepts a search_string and filters the output to match the regular expression.

- With the delete, poweroff and reset subcommand, this option forces the operation.

-g|--gear

Identifies a specific managed server, chassis, or operating system. For the apply_firmware andreinstall_agent subcommands, this option accepts a list of assets.

-l

- With the list subcommand, this option specifies that the output includes additional information about the asset: Status, Lock Info, Zone. This option can also be invoked as --detail.

- With the set subcommand, this option controls whether the locator lights are on or off. This option can also be invoked as --locator.

-n

- With the set subcommand, this option enables and disables notifications. You can also represent this option as --notifications.

- With the update subcommand, this option specifies the new name of the asset. You can also represent this option as --name.

- With the reset subcommand, this option specifies a netboot operation instead of booting from disk. You can also represent this option as --netboot.

-p

- With the manage, unmanage, and reinstall_agent subcommands, this option specifies the password for the administrative account for the server, chassis, or operating system. You can also represent this option as -password. Used with the -u option.

- With the apply_firmware,fwprofile_compliance, and provision_os subcommands, this option specifies the firmware profile. The asset is provisioned with the images in the profile.

-s|--semantictags

Adds or changes the semantic tags for a specific asset.

-t

- With the manage and unmanage commands, this option specifies an asset's type. You can also represent this option as --type.

- With the update command, this option adds or changes the legacy tags for a specific asset. You can also represent this option as --tags.

-u|--user

Specifies the account name for the administrative account for the server, chassis, or operating system. Used with the -p option.

-v|--version

Specifies the version number of the agent software.

-U|--UUID

Specifies an asset by its Universal Unique Identifier. This is useful when assets have the same user-friendly name.

--attributes=

Constrains the operation of the command to those assets that match the characteristics listed in attributeslist. Use this method of specifying assets instead of their user-friendly name or UUID.

Operands

assetname

User-friendly name for a specific server, chassis, or operating system. To obtain a name, use the list subcommand.

asset_uuid

Universal Unique Identifier, to distinguish a specific asset from one with the same asset user-friendly name.

attributeslist

A comma-separated list of key-value pairs, used to constrain an operation to assets that match the values.

- For the type key, the values are os, server, or chassis.

- For the UUID key, the value is a valid UUID.

- For the UFN key, the value is an asset's name.

- For the ip key, the value is a valid IPv4 network address.

password

String that acts as the credential for the administrative account of the server, chassis or operating system.

profilename

Identifier of a specific provisioning profile.

search_string

Regular expression used to constrain the output.

text

Text string that describes the asset or acts as a tag.

type

Name of the asset type: os, server, or chassis

username

Name of the administrative account of the server, chassis, or operating system.

version

Version number of the agent software to install on an item of gear.

Examples

Example 1   Display a detailed list of assets

EnterpriseController/gear > list -l
Registered Gear ------------------------------------------------------------------------------- Name: ManagedBox   Description : 192.0.2.10   Managed State : MANAGED   Status : OK   Lock Info : None   Is a Zone : False   Product UUID : 6f1f1dg9-f8sc-8b1b-9c81-ddaab86a261d   Asset Type : Server
Name: EnterpriseController   Description: 192.0.2.5   Managed State: MANAGED   Status: OK   Lock Info: None   Is a Zone: False   Product UUID : 5f1f1dg9-f8sc-8b1b-9c81-ddaab86a261d   Asset Type : Server

Example 2   Display a list of Oracle Solaris assets

EnterpriseController/gear > list --filter 6flfl
Registered Gear
UFN        |  State  | Description  | Type   |         UUID
----------------------------------------------------------------------------------
ManagedBox | MANAGED |192.0.2.10     | Server | abcdedg9-f8sc-8b1b-abcd-b86a261d

Example 3   Display a list of jobs associated with the specific asset, cyclops.

EnterpriseController/gear > show_jobs -g cyclops
Current Jobs     Job ID                Status                Job Type                 Owner     -------------------------------------------------------------------------------     Historical Jobs     Job ID                Status                Job Type                 Owner     -------------------------------------------------------------------------------     cyclops               SUCCESS               ReinstallAgentJob        root     cyclops               SUCCESS               AgentProvisioningJob     root

Example 4   Change the name of an asset from ”cyclops” to ”gorgon”

EnterpriseController/gear > set -g cyclops -n gorgon

Example 5   Deactivate the gorgon asset

EnterpriseController/gear > poweroff -g gorgon

Example 6   Turn off the locator light on the gorgon asset and disable notifications

EnterpriseController/gear > set -g gorgon -l off -n off

Example 7   Reset the gorgon asset using netboot

EnterpriseController/gear > reset -g gorgon -n

Example 8   Add a description and some tags to the gorgon asset

EnterpriseController/gear > update -g gorgon -d Finance_netbt -t os solaris

Example 9   Re-install agent software on the gorgon asset

EnterpriseController/gear > reinstall -g gorgon -v 2.1.0.906 -u Weather101 -p monsoon

Example 10   Restart all operating systems with the name s10

EnterpriseController/gear > reboot --attributes=type=os,UFN=s10

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

groups

Command to initiate the Groups mode and to use its subcommands.

Synopsis

attach -g|--group  groupname -n|--gear assetname [-U|--uuid assetuuid]
create -g|--group groupname [-d|--description text]  [-p|--parent parentgroup]
delete -g|--group groupname [-c|--child]
detach  -g|--group groupname -n|--gear assetname [-U|--uuid assetuuid]
list [-l|--detail] [-b|--brief]
list_members -g|--group groupname
list_membership -n|--gear assetname [-U|--uuid assetuuid]
move -n|--gear assetname [-U|--UUID assetuuid] -f|--from_group groupname_source -g|--group groupname_destination
poweroff -g|--group groupname [-f|--force]
poweron -g|--group groupname [-n|--netboot]
reset -g|--group groupname [-f|--force] [-n|--netboot]
update -g|--group groupname [-n|--name new_groupname] [-d|--description text] [-p|--parent parentgroup]

Description

The Groups mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Groups subcommands to create sets and subsets of assets. You can power on and power off all the assets in a group.

Type the groups command at the command line prompt to enter Groups mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

attach -g|--group groupname -n|--gear assetname [-U|--uuid assetuuid]

Adds a managed asset to an existing group.

create -g|--group groupname [-d|--description text] [-p|--parent parentgroup]

Defines a new user-defined group by its name, purpose, and relationship to another group. The parent group does not have to exist; it can be created at a later time. The relationship between a parent group and its child group is arbitrary and for the convenience of administration

delete -g|--group groupname [-c|--child]

Removes a group. The assets that are members of the group remain in operation but are no longer defined as members of the group. The -c option includes any subgroups of the specified group.

detach -g|--group groupname -n|--gear assetname [-U|--uuid assetuuid]

Removes a managed asset from a group.

list [-l|--detail] [-b|--brief]

Displays a list of all existing groups of assets in Enterprise Manager Ops Center. Use this command to obtain the name for a specific group to use with the other Group subcommands. Add the -l option to the command to include detailed information about the group.

list_members -g|--group groupname

Displays a list of assets that are in the specified group.

list_membership -n|--gear assetname [-U|--uuid assetuuid]

Displays a list of groups of which the named asset is a member. If more than one asset has the same name, specify the asset further by adding the asset's UUID.

move -n|--gear assetname [-U|--UUID assetuuid] -f|--from_group groupname_source -g|--group groupname_destination

Changes the membership of an asset from one group to another group. This command gives the same result as using the detach command and then the attach command.

poweroff -g|--group groupname [-f|--force]

Deactivates any running asset in the group. The -f option, indicating a forced action, deactivates the asset immediately. Use the poweron command to activate the members of the group.

poweron -g|--group groupname [-n|--netboot]

Activates any deactivated asset in the group by booting from disk. The -n option indicates that the asset is started by using netboot.

reset -g|--group groupname [-f|--force] [-n|--netboot]

Resets the specified servers in the group by booting from disk. The [-f] option, indicating a forced action, resets the server immediately. The [-n] option indicates that the reset is accomplished by using netboot.

update -g|--group groupname [-n|--name new_groupname] [-d|--description text] [-p|--parent parentgroup]

Changes the name, description, or parent group of the group.

Options

The following options are supported by some of the subcommands:

-b|--brief

Limits the output to only group names.

-c|--child

Deletes the child groups of the specified group in addition to deleting the group.

-d|--description

Defines a string to identify the contents or purpose of the group.

-f

- For the reset and poweroff subcommands, this option directs the subcommand to complete immediately. The option can also be invoked as --force.

- For the move subcommand, this option specifies the name of the group that is being moved. The option can also be invoked as --from_group.

-g|--group

A string to identify a specific group.

-l|--detail

Specifies that the output of the list includes the details about the group.

-n

- For the move and detach subcommands, this option specifies the name of the asset.

- For the poweron and reset subcommands, this option specifies that each server performs a netboot operation and does not boot from disk. The option can also be invoked as --netboot.

- For the update subcommand, this option specifies the new name of the group.The option can also be invoked as --name.

-p|--parent

Specifies the name of the parent group associated with the new group.

-U|--uuid

Specifies an asset by its Universal Unique Identifier.

--attributes

Specifies a list of asset attributes instead of the asset name.

Operands

The following operands are supported:

assetname

Identifies a specific server, chassis, or operating system.

assetuuid

Universal Unique Identifier, to distinguish a specific asset from one with the same asset name.

attibutes

Attributes of an asset, to distinguish a specific asset from one with the same asset name. The attributes that can be used are the type, UUID, UFN, and IP.

groupname

Identifies a specific group.

groupname_source

Identifies a source group.

groupname_destination

Identifies a destination group.

parentgroup

Identifies a specific group which shares members with a subgroup.

text

Text string that describes the group.

Examples

Example 1   Display a detailed list of groups

EnterpriseController/groups > list -l

Example 2   Create a subgroup of the group nyc_all that contains various types of assets that must remain activated.

EnterpriseController/groups > create -g brooklyn -d alltime -t heterogenous -p nyc_all

Example 3   Add the ddgr42 system to the new group.

EnterpriseController/groups > attach -n ddgr42 -g brooklyn

Example 4   Replace the ddgr42 system with the reese1 system

EnterpriseController/groups > detach -n ddgr42 -g brooklyn attach -n reese1 -g brooklyn

Example 5   Deactivate the entire parent group

EnterpriseController/groups > poweroff -g nyc_all

Example 6   Activate the subgroup.

poweron -g brooklyn

Example 7   Remove a group

EnterpriseController/groups > delete -g leo_d

Example 8   Move ddgr42 to another group

EnterpriseController/groups > move -n ddgr42 -f brooklyn -g nyc_all

Example 9   Update the name and description of the group.

EnterpriseController/groups > update -g brooklyn -n laca -d start1955

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

incidents

Command to initiate the Incidents mode and to use its subcommands. The Incidents subcommands manages notices that thresholds have been exceeded and hardware faults.

Synopsis

acknowledge -i|--incidents incidentID[,incidentID2,..,incidentIDn]  [-n|--note text]
annotate -i|--incidents incidentID[,incidentID2,..,incidentIDn]  [-n|--note text] [-s|--synopsis text] [-t|--type comment|suggested_action]
assign -i|--incidents incidentID[,incidentID2,..,incidentIDn] -u|--user owner [-n|--note text]
close -i|--incidents  incidentID[,incidentID2,..,incidentIDn] [-n|--note text] [-d|--disable-delay minutes]
list [-e|--emitter] [-l|--detail] [-s|--state state] [-u|--user owner] [-C|--limit count]
show -i|--incidents incidentID[,incidentID2,..,incidentIDn]  [-l|--detail]
show_alerts -i|--incidents incidentID[,incidentID2,..,incidentIDn]  [-l|--detail]

Description

The Incidents mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Incidents subcommands to manage the conditions reported by the monitoring feature.

Type the incidents command at the command line prompt to enter Incidents mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list [-e|emitter] [-l|--details] [-s|--state state] [-u|--user owner] [-C|--limit count]

Displays a list of current incidents, up to the default limit of 100 incidents. You can restrict the list to the specified type of incident (state), the specified emitter, or the specified assigned owner. You can also control the number of incidents in the display, using 0 to see all incidents.

show -i|--incidents incidentID[,incidentID2,..,incidentIDn] [-l|--detail]

Displays detailed information about one or more incidents.

show_alerts -i|--incidents incidentID[,incidentID2,..,incidentIDn] [-l|--detail]

Displays a list of alert notifications for the specified incident.

acknowledge -i|--incidents incidentID[,incidentID2,..,incidentIDn] [-n|--note text]

Accepts the assignment of one or more incidents. You can add some text to the detailed information to indicate activity on the incidents such as the type of investigation or status.

annotate -i|--incidents incidentID[,incidentID2,..,incidentIDn] [-n|--note text] [-s|--synopsis text] [-t|--type comment|suggested_action]

Adds a synopsis of your new information to the detailed information for one or more incidents. You can combine the synopsis with a longer note or with the type of annotation.

assign -i|--incidents incidentID[,incidentID2,..,incidentIDn] -u|--user owner [-n|--note text]

Attaches one or more incidents to the specified user name. After an incident is assigned, the new owner of the incident uses the acknowledge subcommand to accept the assignment.

close -i|--incidents incidentID[,incidentID2,..,incidentIDn] [-n|--note text] [-d|--disable-delay minutes]

Makes the incident inactive, because the investigation by the owner indicates the incident is not an issue or has resulted in the incident being resolved. Use the -d option to suspend monitoring for a set number of minutes.

Options

-C|--limit

Specifies the number of incidents in the list of incidents.

-d|--disable-delay

Suspends the monitoring of threshold conditions.

-l|--detail

Includes details in the display of information.

-e|--emitter

Includes the name and UUID of the asset that is generating the incident.

-l|--detail

Includes details in the display of information.

-n|--note

Adds text to the incident to update progress or give resolution.

-s

- With the annotate subcommand, this option adds a synopsis that is displayed when the list subcommand is used. The option can also be invoked as --synopsis.

- With the list subcommand, this option restricts the display to those incidents that match the state of the incident. The option can also be invoked as --state.

-t|--type

Modifies an annotation to label its type. Type can be either Comment or Suggested Action.

-u|--user

Specifies the name of the account that is responsible for investigating the incident.

Operands

count

An integer to indicate the number of incidents in the list of incidents. The default value is 100. Use a value of 0 to see all incidents.

incidentID

The identifier for an incident or a comma-separated list of identifiers.

minutes

An integer to indicate the number of minutes to suspend monitoring.

owner

The user account that is assigned an incident.

state

Indicates an incident's state filter.

text

Text that describes a synopsis or a note.

See Also

oc(5), credentials(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

jobs

Command to initiate the Jobs mode and to use its subcommands.

Synopsis

delete -x|--id jobID
list [-l --detail] [-x|--id jobID] [-o|--owner job_ownername] [-s|--status job_status]  [-t|--type job_type] [-f|--filter search_string] [-r|--runid runID] [-S|--sort jobid|jobname|job_ownername|createDate|endDate|startDate|endDate|duration] [-A|--ascend] [-m|--matchAll] [-C|--limit integer] [-L|--nologdetails]
rerun_on_failed -x |--id jobID
run -x|--id jobID [-s|--simulate]
stop -x|--id jobID

Description

The Jobs mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Jobs subcommands to view current and historical jobs and to manage current jobs.

Type the jobs command at the command line prompt to enter Jobs mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list [-l|--detail] [-x|--id jobID] [-o|--owner job_ownername] [-s|--status job_status] [-t|--type job_type] [-f|--filter search_string] [-r|--runid runID] [-S|--sort jobid|jobname|job_ownername|createDate|endDate|startDate|endDate|duration] [-A|--ascend] [-m|--matchAll] [-C|--limit integer] [-L|--nologdetails]

Displays a list of all current jobs and completed jobs. Use this command to obtain the identifier of a specific job to use with other Jobs subcommands. Add the -l option to the command to display detailed information about the jobs. Add the -x option to the command to display information about a specific job. Use the other options to limit the display to those items that match the criteria and use the -A option to change the order of the results.

delete -x|--id jobID

Removes a job. The job must be completed or stopped before it can be deleted. Deleted jobs remain in the display of historical jobs.

rerun_on_failed -x|--id jobID

Runs the specified job again on failed targets. A job that has a status of PARTIALLYSUCCESSFUL has failed on at least one target.

run -x|--id jobID [-s|--simulate]

Runs the specified job. The --simulate option performs the actions of the job but does not execute it.

stop -x|--id jobID

Stops a job and cancels it. The job must be re-created to be run again.

Options

-A|--ascend

The default order of a list is in descending order. This option changes the output of the command to ascending order.

-C|--limit

Constrains the list of jobs to the specified number of jobs.

-f|--filter

Constrains the output of a subcommand to match the regular expression.

-l|--detail

Specifies that the output of the list subcommand includes additional information: creation date, end date, and each task in the job.

-L|--nologdetails

Constrains the details of a job to exclude the log of a job.

-m|--matchAll

The default search reports the all jobs that match any of the search criteria. This option limits the output of the command to jobs that match all of the criteria.

-o|--owner

Specifies that the output of the command lists jobs that match the owner of the job.

-r|--runid

Specifies that the output of the list command includes information for a specific execution of a specific job. The default operation displays information for the most recent run of the job.

-s

- With the list command, the output of the command lists jobs that match the status of the job. The option can also be invoked as --status.

- With the run command, the actions of the job are performed but not executed. THe option can also be invoked as --simulate.

-S|--sort

The default order of a list is in descending order of the job identifier. This option changes the output of the command to sort the jobs according to the specified attribute.

-t|--type

The output of the command lists jobs that match the specified type.

-x|--id

Specifies that the subcommand acts on a specific job.

Operands

createDate, endDate, startDate

Constrains the output to jobs that match the specified dates.

duration

Constrains the output to jobs that match the length of time.

jobID

The identifier of a specific job. To obtain a job identifier, use the list subcommand.

job_ownername

Constrains the output to jobs of the specified owner.

job_status

Constrains the output to jobs with the specified status.

job_type

Constrains the output to jobs with the specified type.

runID

The identifier of a specific execution of a job. The run ID is included in the details of a job.

search_string

Regular expression used to constrain the output.

Examples

Example 1   Display a detailed list of jobs

EnterpriseController/jobs > list -l -x amritsar.1
Job Id: EnterpriseCo.1   Created By: root   Type: DeleteAssetJob   Status: PARTIALLYSUCCESSFUL   Creation Date: Mon Jun 22 13:07:59 MDT 2010   End Date: Mon Jun 22 13:08:17 MDT 2010   Run Id: 1     Task Id: 1     Task Name: DeleteSvcTagsTask       Target: __satellite/com.sun.hss.domain:name="urn:st:fc619676",type=ServiceTag         Status: SUCCESS         Cause Code:         Message: Deleted service tag. (86011)           DEBUG :  Service Tag deletion started on             __satellite/com.sun.hss.domain:name="urn:st:fc61n
(output omitted)

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

monitoring

Command to initiate the Monitoring mode and to use its subcommands.

Synopsis

enable
disable
list

Description

The Monitoring mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Monitoring subcommands to view and globally manage the asset monitoring services.

Type the monitoring command at the command line prompt to enter Monitoring mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

enable

Globally enables all monitoring rules.

disable

Globally disables all monitoring rules.

list

Lists the enabled state for the monitoring rules.

Options

None.

Operands

None.

Examples

Example 1   Display the state of asset monitoring services.

EnterpriseController/monitoring > list

Example 2   Enable all asset monitoring rules.

EnterpriseController/monitoring > enable

Example 3   Disable all asset monitoring rules.

EnterpriseController/monitoring > disable

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), gear(1), groups(1), incidents(1), jobs(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), stats(1), update(1), user(1), virtualization(1).

networks

Command to initiate the Networks mode and to use its subcommands.

Synopsis

list

Description

The Networks mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Networks subcommands to view the list of managed networks.

Type the networks command at the command line prompt to enter Networks mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

list [-l|--detail]

Displays the list of managed networks.

Options

The following option is supported by the list subcommand:

-l|--detail

Specifies that the output of the list includes the details about the managed networks.

Operands

None.

Examples

Example 1   Display a simplified list of managed networks.

EnterpriseController/networks > list

Example 2   Display a detailed list of managed networks.

EnterpriseController/monitoring > list -l

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), notifications(1), osimage(1), osprofile(1), reports(1), stats(1), update(1), user(1), virtualization(1).

notifications

Command to initiate the Notifications mode and to use its subcommands.

Synopsis

delete -i|--notification_id notificationID[,notificationID1,notificationID2,...notificationIDn] [-u|--username username]
list [-l|--detail] [-f|--filter  search_string] [-s|--severity severity_level] [-c|--count count] [-u|--username username] [-i|--notification_id notificationID] [-r|--status status]

Description

The Notifications mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Notifications subcommands to view and delete notifications.

Type the notification command at the command line prompt to enter Notification mode. Type the end command to stop the mode and to return to the command line prompt.

Notifications are created as the result of running jobs, indicating that a job has started or ended, that a task has completed or expired without completing, or that an error has occurred.

Subcommands

list [-l|--detail] [-f|--filter search_string] [-s|--severity severity_level] [-c|--count count] [-u|--username username] [-i|--notification_id notificationID] [-r|--status status]]

Displays a list of all notifications. Use the options to constrain the output to notifications that match the criteria.

Id: 43
User: root
Date: 2010-091-23 14:23:28.052028
Severity: Low
Type: Info
Message:  Error in OS Updates Module. (35057) GUUS is not accessible.
Check that the SOA username and password is set correctly and that
networking is properly configured.(35058)

delete -i|--notification_id notificationID[,notificationID1,notificationID2,...notificationIDn] [-u|--username username]

Removes specific notifications. Use the list command to get the identification number of the notification or the owner of the notification.

Options

-c|--count

Restricts the output of the command to the specified number of notifications.

-f|--filter

Restricts the output of the command to notifications that match the specified regular expression.

-i|--notification_id

Identifies a specific notification.

-l|--detail

Displays details about the notification.

-r|--status

Restricts the output of the command to notifications of the specified status.

-s|--severity

Restricts the output of the command to notifications of the specified severity level.

-u|--username

Restricts the output of the command to notifications of the owner.

Operands

notificationID

The number of the notification, as shown in the output of the list command.

search string

A regular expression that is used to match notifications.

severity_level

The type of notification to include: HIGH, MEDIUM, or LOW.

count

The number of notifications to display. Integer value or MAX.

username

The identifier for the owner of the job that generated the notification.

notificationID

The unique identifier for each notification.

status

READ|UNREAD.

Examples

Example 1   To delete a notification

EnterpriseController/notifications > delete -i 43

Example 2   To filter the notifications

EnterpriseController/notifications > list -- filter High

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

osimage

Command to initiate the Osimage mode and to use its subcommands.

Synopsis

delete -n|--name imagename
import -f|--filename filename -n|--name imagename [-d|--description description]
list [-l|--detail]

Description

The Osimage mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Osimage subcommands to view a list of ISO images and to add and delete images.

Type the osimage command at the command line prompt to enter Osimage mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list [-l|--detail]

Displays a list of all images managed by Ops Center. Use this command to obtain the name for a specific image to use with the other Osimage subcommands. Add the -l option to the command to display detailed information about the images.

Image Name:  SLES-10-sp2
Image Type:  iso
Description:  SLES-10-sp2
Version:  SUSE-Linux-Enterprise-Server-SP2-10.2-0
OS Type:  suse
Guest OS Type:  linux

import -f|--filename filename -n|--name image_name [-d|--description description]

Creates a job that includes an image in Enterprise Manager Ops Center, using an image that resides on the Enterprise Manager Ops Center's system's local file system.

delete -n|--name image_name

Removes an image from Enterprise Manager Ops Center management.

Options

-d|--description

Describes the image.

-f|--filename

Specifies the location of the image file.

-l|--detail

Adds the following attributes to the output of the list subcommand:

Guest OS Variant
Is HVM Capable
Is PV Capable
Parent ISO Name
Profile Name
Profile Description
Profile DistroName
Profile OSVersion
Profile Platform
Profile Scripts

-n|--name

Identifies a specific image by name.

Operands

description

String that describes the image in the file.

imagename

The identifier of a specific image file.

filename

Specifies an existing image on the local file system, including path and filename.

Examples

Example 1   Display detailed information about images

EnterpriseController/osimage > list -l
Image Name:  SLES-10-sp2
Image Type:  iso
Description:  SLES-10-sp2
Version:  SUSE-Linux-Enterprise-Server-SP2-10.2-0
OS Type:  suse
Guest OS Type:  linux
Guest OS Variant:  sles10
Is HVM Capable:  True
Is PV Capable:  True
Parent ISO Name:  None
Profile Name:  SLES-10-sp2
Profile Description:  SLES-10-sp2
Profile DistroName:  SLES-10-sp2
Profile OSVersion:  SUSE-Linux-Enterprise-Server-SP2-10.2-0
Profile Platform:  x86
Profile Scripts:

Example 2   Import a new ISO image, Solaris10U6, from an image that is in the local file system

EnterpriseController/osimage > import -f /images/dvd-s10u6-x86.iso -n Solaris10U6 -d "Solaris 10 Update 6"

Example 3   Remove an image

EnterpriseController/osimage > delete -n Solaris10U6

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

osprofile

Command to initiate the OSProfile mode and to use its subcommands.

Synopsis

clone -p|--profile profilename -n|--name profile_name_new
delete -p|--profile profilename
export -p|--profile profilename  -f|--file file_name
import -f|--file filename
import_jet_template -p|--profile profilename -i|--image os_image -t|--template_path path
list -l|--detail

Description

The OSProfile mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use OSProfile subcommands to view a list of operating system profiles, to import new profiles from a local file system, and to export profiles to files.

Type the osprofile command at the command line prompt to enter OSProfile mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

clone -p|--profile profilename -n|--name profilename_new

Copies an OS profile to one with a different name.

delete -p|--profile profilename

Removes an OS profile.

export -p|--profile profilename -f|--file filename

Moves a profile to a file with the extension .prof.

import -f|--file filename

Adds an operating system profile from a file. The file must have the prof extension. Before you import a profile that was exported previously, change the Name and Payload_Name fields.

import_jet_template -p|--profile profilename -i|--image os_image -t|--template_path path

Includes a JET template for OS provisioning.

list -l|--detail

Displays a list of profiles. Use this command to obtain the name of a specific profile to use with the other OSProfiles subcommands.

Options

-i|--image

Specifies an OS ISO image.

-l|--detail

Includes details in the list of profiles.

-n|--name

Specifies a new operating system profile.

-p|--name

Specifies an operating system profile.

-f|--file

Specifies a name for the file with the exported profile.

-t|--template_path

Specifies the path to the JET template.

Operands

os_image

Name of ISO file with OS image.

path

Full path for the local location of the OS image file.

profilename

Name of an operating system profile.

filename

Name of the new file that contains exported profile.

Examples

Example 1

EnterpriseController/osprofile > list
Profile Name: sles10Jeff1
Description: linux enterprise server at Jeff
DistroName: sles10
OS Version: SUSE-Linux-Enterprise-Server-SP2-10.2-0
Platform: x86

Example 2   Imports the ddgr profile

EnterpriseController/osprofile > import -p ddgr.prof
Successfully import profile from 'ddgr.prof'

Example 3   Exports the ddgr profile

EnterpriseController/osprofile > export -p ddgr -f la_ddgr.prof

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), reports(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

reports

Command to initiate the Reports mode and to use its subcommands.

Synopsis

check
cleanup [-t|--t pause_time] [-q|--quiet]
convert [-p partitionID [-n number_of_samples]] [-q|--quiet]
delete -p|--id partitionID [-t|--t pause_time] [-q|--quiet]
disable
enable
info
list
partition -p|--id partitionID [-s|--state] [-k|--hourly] [-d|--daily] [-w|--weekly] [-m|--monthly] [-t|--stats] [-f|--full]
pause -t|--t pause_time
purge [-p partitionID [-n number_of_samples]] [-q|--quiet]
reset -p|--id partitionID [-t|--t pause_time] [-q|--quiet]
reset_stats
rollup [-p|--id partitionID] [-t|--t pausetime] [-q|--quiet]
show
start
stats
stop
urns -p|--id partitionID [-u|--urn urn_name] [-q|--quiet]

Description

The Reports mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Groups subcommands to perform actions related to the reporting service such as viewing the collection of samples, called partitions, deleting a partition, applying the rollup and cleanup processes to a partition, and reverting the rollup process.

Type the reports command at the command line prompt to enter Reports mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

check

Checks each partition to determine if a conversion is necessary.

cleanup [-t|--t pause_time] [-q|--quiet]

Start the cleanup process, removing very old samples in a partition.

convert [-p|--id partitionID [-n number_of_samples]] [-q|--quiet]

Converts samples of a partition to a new format.

delete -p|--id partitionID [-t|--t pause_time] [-q|--quiet]

Deletes a specific partition.

disable

Disables automatic rollup and cleanup in a partition.

enable

Enables automatic rollup and cleanup in a partition.

info

Displays detailed information about the rollup and cleanup processes.

list

Displays a list of all partitions managed by the reporting service.

partition -p|--id partitionID [-s|--state] [-k|--hourly] [-d|--daily] [-w|--weekly] [-m|--monthly] [-t|--stats] [-f|--full]

Displays detailed information about a partition, including its state, and the number of daily, hourly, weekly, monthly, or stats samples.

pause -t|--t pause_time

Sets the pause time used for the rollup and cleanup processes.

purge [-p|--id partitionID [-n number_of_samples]] [-q|--quiet]

Purges the old format samples of a partition.

reset -p|--id partitionID [-t|--t pause_time] [-q|--quiet]

Resets a specific partition to revert the effects of a rollup that has been previously applied.

reset_stats

Resets the statistics related to the rollup and cleanup processes.

rollup [-p|--id partitionID] [-t|--t pause_time] [-q|--quiet]

Starts the rollup process, calculating the average of samples in a partition. If no partition is given, the reporting service automatically selects the oldest partition that has not been rolled up already.

show

Displays the current status of the reporting service.

start

Starts the reporting service without restarting the Enterprise Controller.

stats

Displays the statistics related to the rollup and cleanup processes.

stop

Stops the reporting service without stopping the Enterprise Controller.

urns -p|--id partitionID [-u|--urn urn_name] [-q|--quiet]

Displays a list of assets with at least one sample in a specific partition. If no urn name is given, the list of urns that have at least one sample in the partition is shown. This list includes the number of samples for each urn. If a urn name is given, the list of attributes of this urn that have at least one sample is displayed. This list includes the number of samples for each attribute.

Options

The following options are supported by some of the subcommands:

-d|--daily

Display the number of daily samples.

-f|--full

Display all the information about a partition.

-k|--hourly

Display the number of hourly samples.

-m|--monthly

Display the number of monthly samples.

-n| --n

Specifies the number samples.

-p|--id

Specifies a partition by its ID.

-q|--quiet

Avoids displaying warning messages.

-s|--state

Display the state of the partition.

-t

- For the partition command, this option displays the number of stats samples.The option can also be invoked as --stats.

- For the cleanup, delete, pause, reset, and rollup command, this option is an integer that specifies the pause time in milliseconds.The option can also be invoked as --t.

-u|--urn

Specifies a urn name.

-w|--weekly

Display the number of weekly samples.

Operands

The following operands are supported:

number_of_samples

Integer to specify the samples for the convert or purge subcommands.

partitionID

The identifier of a partition. To obtain a job identifier, use the list command.

pause_time

Integer to specify the pause time in milliseconds.

urn_name

Identifies the asset for which the list of attributes is requested. An urn name is an object name.

Examples

Example 1   Display the number of monthly samples in a partition

EnterpriseController/reports > partition -p 20120514 -m

Example 2    Display a list of assets with at least one sample in a specific partition

EnterpriseController/reports > urns -p 20120514

Example 3   Start the rollup process

EnterpriseController/reports > rollup -p 20120514 -t 10

Example 4   Start the cleanup process

EnterpriseController/reports > cleanup

Example 5   Delete a partition

EnterpriseController/reports > delete -p 20120514

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), serverpools(1), stats(1), update(1), user(1), virtualization(1).

serverpools

Command to initiate the ServerPools mode and to use its subcommands.

Synopsis

list
list_members -U|--UUID server_pool_uuid [-l|--detail]
remove_members -U|--UUID server_pool_uuid -M|--members server_uuid [-f|--force]

Description

The ServerPools mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use ServerPools subcommands to view and manage server pools.

Type the serverpools command at the command line prompt to enter ServerPools mode. Type the end to stop the mode and to return to the command line prompt.

Subcommands

list

Displays a list of all existing server pools.

list_members -U|--UUID server_pool_uuid [-l|--detail]

Displays a list of members that are part of a server pool. Add the -l option to the command to include detailed information about the members of the server pool.

remove_members -U|--UUID server_pool_uuid -M|--members server_uuid [-f|--force]

Removes a member or a list of members from a server pool.

Options

The following options are supported by some of the subcommands:

-f|--force

Forces the server removal from the server pool.

-l|--detail

Specifies that the output of the list includes the details about the members of the server pool.

-M|--members

Identifies a member or a list of members from a server pool to be removed from it.

-U|--UUID

Specifies an asset by its Universal Unique Identifier.

Operands

The following operands are supported:

server_pool_uuid

Universal Unique Identifier, to distinguish a specific server pool from one with the same asset name.

server_uuid

Universal Unique Identifier, to distinguish a specific server from one with the same asset name.

Examples

Example 1   Display a list of existing server pools,

EnterpriseController/serverpools > list

Example 2   Display the list of members from a server pool.

EnterpriseController/serverpools > list_members --UUID 7e60dcd8-b749-4dd4-ad4e-0525b17181c9 --detail

Example 3   Remove a server from a server pool.

EnterpriseController/serverpools > remove_members -U 2d602947-596e-4361-8910-8504c03a470d -M a38b1dac-4299-4066-bea0-af87fa1d2a3e

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), stats(1), update(1), user(1), virtualization(1).

stats

Command to initiate the Stats mode and to use its subcommands.

Synopsis

show [-i|--interval interval]

Description

The Stats mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use the Stats subcommand to view current information about the host.

Type the stats command at the command line prompt to enter Stats mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

show [-i|--interval interval]

Displays the current values for the name of the host, the percent of memory used, the amount of remaining memory, the average load in the last 15 minutes, and the percent of CPU utilization. Use the -i option to repeat the command at the specified number of seconds.

Name         Used Mem %    Free Mem (MB)   Avg Load 15min  CPU util %
hs-x4100-1   34.28         6646              1.74           75.00

Options

-i|--interval

Specifies the time to wait before repeating the command.

Operands

interval

The number of seconds to wait for the next repetition of the command.

Press Ctrl+d or q to cancel the command.

Examples

Example 1   Repeat the command every 5 seconds

EnterpriseController/stats > show --interval 5

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), update(1), user(1), virtualization(1).

update

Command to initiate the Update mode and to use its subcommands.

Synopsis

add_configuration_file -f|--filename filename -p|--pathname path -v|--version version -c|--categoryname category -D|-d|--description description -C|--channelname channel
add_file_to_distro -f|--file_path path -C|-o|--channelname|--distro_name distro -a|--category_name category [-s|--security]
add_local_action -a|--actionname action -f|--filename filename -p|--parentname parent_category  -D|-d|--description description -C|-c|--channelname channel -t|--actiontype macro|postaction|preaction|probe
add_local_category -c|--category_name category -p|--parent_name parent_category -D|-d|--description description -C|-o|--channelname|--distro distro
apply_profile_to_gear -g|--gear assetname -y|--policy policyname -f|--profilename profilename [-r|--failure_policy continue|abort_any] [-x|--execution_policy sequential|parallel] [-j|--jobname job_name] [-e|--jobdesc job_description] [-k|--taskname task_name] [-o|--seconds seconds] [-a|--actual]
bulk_upload_directory -C|-D|--channelname|--distribution distribution -d|--directory directory
check_disconnected
check_guus [-u|--user username] [-p|--password password] [--proxy proxy_hostname] [--port proxy_port] [--proxyuser proxy_username] [--proxypass  proxy_password]
check_inventory -g|-gear assetname [-a|--allgear] [-t|--snapshot snapshotname] [-f|--filename filename] [-c|--cvs] [-d|--delimiter delimiter] [-e|--enclosure enclosure] [-r|--header] [-p|--append]
create_historical_snapshot -g|--gear assetname -s|--snapshotname snapshotname [-D|--description description]
create_profile [--si search_string] [--su search_string] [--sr search_string] [--ni nodeID] [--nu nodeID] [--nr nodeID] [-f|--profilename  profilename] [-C|-o|--channelname|--distro distro] [-D|-l|--description|--profile_desc description] [-t|--type type] [-a|--all] [-c|--case] [-r|--replace][-p|--loop]
create_profile_from_inventory -g|--gear assetname [-t|--snapshot snapshotname] [-f|--profilename profilename] [-r|--include_removes]
delete_component -i|--nodeid nodeID -C|d|--channelname|--distro distribution [-k|--donotcheckforinstall]
delete_profiles -p|--profilename profilename[,profilename2,...,profilenamen]
delete_snapshots [-g|--gear assetname] [-s|--snapshot snapshotname]
find_nodes -s|--search_string search_string [-a|--all] [-l|-detail] [-c|--case]
get_job_status -i|--jobids jobID[,jobID2,...,jobIDn] [-a|--alljobs] [-l|--detail] [-c|--cvs] [-r|--header] [-f|--filename filename] [-d|--delimiter delimiter] [-e|--enclosure enclosure] [-p|--append]
job_history -g|--gear assetname[,assetname2,..,assetnamen] [-f|--fromdate from_date] [-t|--todate to_date] [-i|--jobids jobID[,jobID2,...,jobIDn]] [-l|--detail] [--fail] [--ok] [--warning] [--nostatus] [--install] [--upgrade] [--uninstall] [--downgrade] [-L|--log]
list_distros  [-a|--all]
list_policies [-l|--detail] [-p|--policyname policyname]
list_profiles [-l|--detail] [-p|--profilename profilename]
list_snapshots -g|--gear assetname
load_kb_bundle -f|--filename path
modify_gear -g|--gear assetname -y|--policy policyname [--si search_string] [--su search_string] [--sr search_string] [--ni nodeID] [--nu nodeID] [--nr nodeID] [-j|--jobname job_name] [-e|--jobdesc  job_description] [-k|--taskname task_name] [-f|--profilename profilename] [-D|--description description] [-r|--failure_policy continue|abort_any] [-x|--execution_policy sequential|parallel] [-o|--seconds seconds] [-c|--case] [-a|--actual] [-d|--desc] [-p]
search_inventory -s|--search_string search_string [-g|--gear assetname] [-a|--allgear] [-t|--snapshot snapshotname] [-D|--description description] [-l|--detail] [-c|--cvs] [-f|--filename filename] [-d|--delimiter delimiter] [-e|--enclosure enclosure] [-p|--append] [-o nb_loop]
set_component_file -n|--componentname componentname -d|--distro distro -f|--filename filename
set_connected_mode [-c|--connected]|[-d|--disconnected]

Description

The Update mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use Update subcommands to manage the local inventory of a host.

Type the update command at the command line prompt to enter Update mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

add_configuration_file -f|--filename filename -p|--pathname path -v|--version version -c|--categoryname category -D|-d|--description description -C|--chanelname channel

Adds a configuration file to a category.

add_local_action -a|--actionname action -f|--filename filename -p|--parentname parent_category -D|-d|--description description -C|-c|--channelname channel -t|--actiontype macro|postaction|preaction|probe

Adds an action to a category. The action's type can be macro, postaction, preaction, or probe

add_local_category -c|--category_name category -p|--parent_name parent_category -D|-d|--description description -C|-o|--channelname|--distro distro

Adds a category into the hierarchy of categories in a distribution. Use the -r option to refresh the hierarchy.

check_disconnected

Displays the current connection mode.

job_history -g|--gear assetname[,assetname2,..,assetnamen] [-f|--fromdate from_date] [-t|--todate to_date] [-i|--jobids jobID[,jobID2,...,jobIDn]] [-l|--detail] [--fail] [--ok] [--warning] [--nostatus] [--install] [--upgrade] [--uninstall] [--downgrade] [-L|--log]

Displays update jobs for the assets that match the criteria.

get_job_status -i|--jobids jobID[,jobID2,...,jobIDn] [-a|--alljobs] [-l|--detail] [-c|--cvs] [-r|--header] [-f|--filename filename] [-d|--delimiter delimiter] [-e|--enclosure enclosure] [-p|--append]

Displays or creates a file of the status of all jobs or the specified job that match the criteria. The format of the results is columnar by default or in detail if you used the -l option. To get the results in CSV format, use the -c option and then use the -d, -e, and -roptions to control the appearance of the CSV format. To append the results to an existing file, use the -p option with the -f option.

set_connected_mode [-c|--connected]|[-d|--disconnected]

Change the connection mode of the update operation. Use the -d option to set the mode to Disconnected and disallow any updates to assets. Use the -c option to restore the default mode, Connected.

Displaying information

The following command display information about the inventory.

list_distros [-a|--all]

Displays a list of active distribution packages. Use the -a to see all distributions packages.

list_policies [-l|--detail] [-p|--policyname policyname]

Displays a list of all available policies.

list_profiles [-l|--detail] [-p|--profilename profilename]

Displays a list of all available profiles.

list_snapshots -g|--gear assetname

Displays a list of the snapshots. Use the -g option to display the snapshots for the specified asset.

find_nodes -s|--search_string search_string [-a|--all] [-l|-detail] [-c|--case]

Searches for all node identifiers that match the search string. Use the -a option to search for all nodes. Use the -c option to require that the case of the search string match. Use the -l option to include details of the node in the output.

Inventory

The following commands manage inventory updates.

check_guus [-u|--user username] [-p|--password password] [--proxy proxy_hostname] [--port proxy_port] [--proxyuser proxy_username] [--proxypass proxy_password]

Sends a request for new software to Knowledge Base.

check_inventory -g|-gear assetname [-a|--allgear] [-t|--snapshot snapshotname] [-f|--filename filename] [-c|--cvs] [-d|--delimiter delimiter] [-e|--enclosure enclosure] [-r|--header] [-p|--append]

Determines whether inventory information is available for the specified asset or snapshot. Use the -a option to check all assets. The alternative is to use the -g option to search a specific asset and, optionally, its snapshots by adding the -t option. When you use the -a option, the results are written to a file in comma-separated format (CSV). When you use the -g option, the results are displayed or you can use the -f option to direct the output to a file. The format of the results is columnar by default or in detail if you used the -l option. To get the results in CSV format, use the -c option and then use the -d, -e, and -roptions to control the appearance of the CSV format. To append the results to an existing file, use the -p option with the -f option.

search_inventory -s|--search_string search_string [-g|--gear assetname] [-a|--allgear] [-t|--snapshot snapshotname] [-D|--description description] [-l|--detail] [-c|--cvs] [-f|--filename filename] [-d|--delimiter delimiter] [-e|--enclosure enclosure] [-p|--append] [-o nb_loop]

Searches the inventory of the host for assets that match the search string or use the -a option to search for all assets. The alternative is to use the -g option to search for a specific asset and, optionally, its snapshots by adding the -t option. With either type of search, use the -n option to search within descriptions and the -l option to include the detailed information in the results. When you use the -a option, the results are written to a file in comma-separated format (CSV). When you use the -g option, the results are displayed or you can use the -f option to direct the output to a file. The format of the results is columnar by default or in detail if you used the -l option. To get the results in CSV format, use the -c option and then use the -d and -e options to control the appearance of the CSV format. To append the search results to an existing file, use the -p option with the -f option.

create_historical_snapshot -g|--gear assetname -s|--snapshotname snapshotname [-D|--description description]

Creates a snapshot file for the specified asset.

delete_snapshots [-g|--gear assetname] [-s|--snapshot snapshotname]

Removes all snapshots or a specific snapshot for all assets or for a specific asset.

Profiles

The following commands manage profile updates.

apply_profile_to_gear -g|--gear assetname -y|--policy policyname -f|--profilename profilename [-r|--failure_policy continue|abort_any] [-x|--execution_policy sequential|parallel] [-j|--jobname job_name] [-e|--jobdesc job_description] [-k|--taskname task_name] [-o|--seconds seconds] [-a|--actual]

Applies a profile to the specified asset, according to the specified policy.

create_profile [--si search_string] [--su search_string] [--sr search_string] [--ni nodeID] [--nu nodeID] [--nr nodeID] [-f|--profilename profilename] [-C|-o|--channelname|--distro distro] [-D|-d|--description description] [-t|--type type] [-a|--all] [-c|--case] [-r|--replace][-p|--loop]

Create a profile for packages that match one or more of the criteria: the name of the distribution, profile, description, or creator and that installs, upgrades, or uninstalls the packages.

create_profile_from_inventory -g|--gear assetname [-t|--snapshot snapshotname] [-f|--profilename profilename] [-D|--description description] [-r|--include_removes]

Create a profile from packages that match one or more of the criteria: the name of the distribution, profile, description, or creator.

delete_profiles -p|--profilename profilename[,profilename2,...,profilenamen]

Removes a profile.

Packages

The following commands manage package updates.

modify_gear -g|--gear assetname -y|--policy policyname [--si search_string] [--su search_string] [--sr search_string] [--ni nodeID] [--nu nodeID] [--nr nodeID] [-j|--jobname jobID] [-e|--jobdesc job_description] [-k|--taskname task_name] [-f|--profilename profilename] [-D|--description description] [-r|--failure_policy continue|abort_any] [-x|--execution_policy sequential|parallel] [-o|--seconds seconds] [-c|--case] [-a|--actual] [-d|--desc] [-p]

Installs, upgrades, or uninstalls files that match the criteria.

add_file_to_distro -f|--file_path path -C|-o|--channelname|--distro_name distro_name -a|--category_name category [-s|--security]

Adds the file specified in the path on the Enterprise Controller to the distribution in the specified category. Use the -s option to mark the file for security.

bulk_upload_directory -D|--distribution distribution -d|--directory directory

Uploads the contents of the directory and its subdirectories to the Updates software library.

delete_component -i|--nodeid nodeID -C|-d|--channelname|--distro distribution [-k|--donotcheckforinstall]

Remove a node from a distribution. Use the -k option to prevent checking for an install status.

load_kb_bundle -f|--filename path

Uploads current data from the specified location on the Enterprise Controller system.

set_component_file -n|--componentname componentname -C|-d|--channelname|--distro distro -f|--filename filename

Specifies the component file.

Options

-a

- With the list_distros, create_profile, find_nodes, and get_job_status commands, this option specifies that all objects or all matching jobs are included. The option can also be invoked as --all with the list_distros, create_profile, and find_nodes, and as --alljobs with the get_job_status command.

- With the add_files_to_distro commands, this option specifies the name of a category. The option can also be invoked as --category_name.

- With the add_local_action command, this option specifies the name of an action. The option can also be invoked as --actionname.

- With the modify_gear and apply_profile_to_gear commands, this option specifies that the command is not simulated and runs to completion. The option can also be invoked as --actual.

- With the search_inventory and check_inventory commands, this option includes all assets in the inventory. The option can also be invoked as --allgear.

-c

- With the add_local_action command, this option specifies a channel. The option can also be invoked as --channelname.

- With the add_configuration_file and add_local_category commands, this option specifies a category name. The option can also be invoked as --category_name with the add_configuration_file command, and as --categoryname with the add_local_category command.

- With the create_profile, modify_gear, and find_nodes commands, this option specifies that a match is case-sensitive. The option can also be invoked as --case.

- With the search_inventory, check_inventory, and get_job_status commands, this option creates output in comma-separated format, overriding any other output options. The option can also be invoked as --cvs.

- With the set_connected_mode command, this option restores the default mode, connected. The option can also be invoked as --connected.

-d

- With the modify_gear command, this option specifies text that describes the object or that a search includes the description. The option can also be invoked as --desc.

- With the bulk_upload_directory, this option specifies the full path to the source directory, where the files to be uploaded are located. The contents of the directory and its subdirectories are uploaded. The option can also be invoked as --directory.

- With the delete_component and set_component_file commands, this option specifies the name of a distribution package. The option can also be invoked as --distro.

- With the set_connected_mode command, this option changes the update mode to disconnected. In disconnected mode, assets are not updated by the Enterprise Controller. The option can also be invoked as --disconnected.

- With the check_inventory, search_inventory, and get_job_status commands, this option specifies the starting character for CSV output. The default is the pipe ( | ) character. The option can also be invoked as --delimiter.

-e

- With the apply_profile_to_gear and modify_gear commands, this option specifies text that describes a job. The option can also be invoked as --jobdesc.

- With the search_inventory, check_inventory, and get_job_status commands, this option specifies the enclosing character for CSV output. The default is the quote (”) character. The option can also be invoked as --enclosure.

-f

- With the add_configuration_file, add_file_to_distro, add_local_action, check_inventory, get_job_status, load_kb_bundle, search_inventory, set_component_file commands, this option specifies the name of a file. The option includes the path if there is no path option. The option can also be invoked as --filename with the add_configuration_file, add_local_action, check_inventory, get_job_status, load_kb_bundle, search_inventory, set_component_file commands, and as --file_path with the add_file_to_distro command.

- With the apply_profile_to_gear, modify_gear, create_profile, and create_profile_from_inventory commands, this option specifies a profile name. The option can also be invoked as --profilename.

- With the job_history command, this option specifies the start date. The option can also be invoked as --fromdate.

-g|--gear

Specifies an asset or a list of assets.

-i

- With the delete_component command, this option specifies a node ID. The option can also be invoked as --nodeid.

- With the job_history and get_job_status commands, this option specifies a job ID. The option can also be invoked as --jobids.

-j|--jobname

Specifies a job name.

-k

- With the apply_profile_to_gear and modify_gear commands, this option specifies the name of a task. The option can also be invoked as --taskname

- With the delete_component command, this option sets the command to not check for install status. The option can also be invoked as --donotcheckforinstall.

-l|--detail

Specifies that detailed information is included in the search or output.

-n|--componentname

Specifies a component by name.

-o

- With the add_local_category, create_profile, and add_file_to_distro commands, this option specifies the name of a distribution package. The option can also be invoked as --distro with the add_local_category, create_profile commands, and as --distro_name with the add_file_to_distro command.

- With the apply_profile_to_gear and modify_gear commands, this option specifies the time in seconds to wait before running a job. The option can also be invoked as --seconds.

-p

- With add_local_action and add_local_category commands, this option specifies the parent category. The option can also be invoked as --parentname with the add_local_action command, and as --parent_name with the add_local_category command.

- With check_guus command, this option specifies a password. The option can also be invoked as --password.

- With the check_inventory, get_job_status, and search_inventory commands, this option appends the output to an existing file. The option can also be invoked as --append.

- With the delete_profiles and list_profiles commands, this options specifies a profile name. The option can also be invoked as --profilename.

- With the list_policies command, this option specifies a policy name. The option can also be invoked as --policyname.

- With the add_configuration_file command, this option specific a path to a file. The option can also be invoked as --pathname.

-r

- With the create_profile command, this option replaces an existing profile. The option can also be invoked as --replace.

- With the create_profile_from_inventory command, this option includes removed packages in the search. The option can also be invoked as --include_removes.

- With the check_inventory and get_job_status commands, this option includes the header line in the CSV output. The option can also be invoked as --header.

- With the modify_gear and apply_profile_to_gear commands, this option specifies the action to take on failure, either to continue or to abort. Default is to continue. The option can also be invoked as --failure_policy.

-s

- With find_nodes and search_inventory commands, this option specifies the string of characters to find in the inventory. The option can also be invoked as --search_string.

- With delete_snapshots and create_historical_snapshot commands, this option specifies a snapshot by its name. The option can also be invoked as --snapshotname.

- With add_file_to_distro command, this option identifies a file as secure. The option can also be invoked as --security.

-t

- With the check_inventory, search_inventory, and create_profile_from_inventory commands, this option specifies a snapshot by name. The option can also be invoked as --snapshot.

- With add_local_action command, this option specifies the type of action: macro, post-action, pre-action, or probe. The option can also be invoked as --actiontype.

- With the job_history command, this option specifies the end date of a query. The option can also be invoked as --todate.

- With the create_profile command, this option specifies the profile type. The option can also be invoked as --type.

-u|--user

Specifies an account name.

-v|--version

Identifies the version of a file

-x|--execution_policy

Specifies the action to take on execution, either in parallel or sequentially. Default is sequential.

-y|--policy

Specifies the name of a policy.

-C|--channelname

Specifies a channel.

-D|--description

- With the add_configuration_file, add_local_action, add_local_category, create_historical_snapshot, create_profile, create_profile_from_inventory, and modify_gear commands, this option specifies text that describes the object. The option can also be invoked as --description.

- With the bulk_upload_directory, this option specifies the distribution name of uploaded files, such as SOLARIS10_SPARC. The option can also be invoked as --distribution.

- With the search_inventory command, this option includes the description in the search. The option can also be invoked as --description.

-L|--log

Records the operation of the job.

--downgrade

Specifies that the output is restricted to jobs of this type.

--fail

Specifies that the output is restricted to jobs of this type.

--install

Specifies that the output is restricted to jobs of this type.

--ni

Specifies the nodes to install.

--nostatus

Specifies that the output is restricted to jobs of this status.

--nr

Specifies the nodes to uninstall.

--nu

Specifies the nodes to upgrade.

--ok

Specifies that the output is restricted to jobs of this status.

--port

Identifies the proxy port of a system.

--proxy

Identifies the proxy system.

--proxypass

Specifies the string that is the credential for the proxy account.

--proxyuser

Specifies the public identifier of the proxy account.

--si

Specifies a search term to add to the install list.

--sr

Specifies a search term to add to the uninstall list.

--su

Specifies a search term to add to the upgrade list.

--upgrade

Specifies that the output is restricted to jobs of this type.

--uninstall

Specifies that the output is restricted to jobs of this type.

--warning

Specifies that the output is restricted to jobs of this status.

Operands

action

Label for the action of a job: install, uninstall, upgrade, downgrade

assetname

Identifier of a asset as displayed in the gear list command.

category

Identifier of a category in the hierarchy.

channel

Identifier of a distribution, a distribution name.

componentname

Identifier for a file in a distribution, a file name.

description

Text that describes the job or profile.

delimiter

Character used to separate the columns in an CSV file. Default is ( | ).

directory

Full path of directory or file system.

distribution

Name of the OS distribution.

distro

Identifier of a distribution package

enclosure

Character used to include all items in a list. Default is ( ” ).

filename

File name without a path

from_date

The starting date of a search. Uses the format YYYYMMDD.

gearname

Identifier for a particular item of gear.

hostname

Fully-qualified name of the host.

job_description

Text that identifies a job.

job_name

Identifier for a job, as shown by the list command.

jobID

Identifies a job by its job ID.

nodeID

Identifies the location of a distribution package.

parent_category

Identifier for a category in the hierarchy to which a new category belongs.

password

String that acts as the credential for an account.

path

Fully-qualified path to the file. Identifies the directory location of a file.

proxy_hostname

Identifier of a proxy host name.

proxy_password

String that acts as the credential for a proxy account.

proxy_port

Identifier of a proxy port of a system.

proxy_username

Identifier of a proxy account.

policyname

Identifier of a policy, as displayed by the list_policies command.

portID

Identifier of a proxy port.

profile_desciption

Text that describes the purpose of the profile.

profilename

Identifier of a profile, as displayed by the list_profiles command.

search_string

Characters to search for in the inventory.

seconds

Number of seconds in the interval before repeating the command. Default is 100.

snapshotname

Identifier for a particular snapshot, as shown by the list_snapshots command.

task_name

Identifier of a task or the profile name.

to_date

The ending date of a search. Uses the format YYYYMMDD.

type

The type of profile.

username

Identifier or an account.

version

The version of a file.

Examples

Example 1   Start Update mode and list all the profiles

#update
EnterpriseController/update > list_profiles

Example 2   Find out whether a host has an inventory of assets

EnterpriseController/update > check_inventory -g Research_svr

Example 3   Search the inventory for assets with ”mysql” in the description or tag

EnterpriseController/update > search_inventory -g Research_svr -s mysql

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1), osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), user(1), virtualization(1).

user

Command to initiate the User mode and to use its subcommands. The User subcommands manages user accounts and user roles.

Synopsis

add_local_user -u|--user username  -r|--role role[,role2,..,rolen]
configureds
delete_local_user -u|--user username
get_directory_servers [-d|--details]
get_ds_users -d|--directory directory_server  [-r|--roles role[,role2,..,rolen]]
grant_local_role -u|--user username  -r|--role role[,role2,..,rolen]
remove_directory_service -d|--directory directory_server
replicate_user_roles -u|--user username -r|--role username
revoke_local_role -u|--user username -r|--role role[,role2,..,rolen]
show_all_local_roles
show_local_users [-r|--roles role[,role2,..,rolen]]
show_local_user_roles -u|--user username
sync_all_ds_users -d|--directory directory_server
sync_ds_user -d|--directory directory_server -u|--user username

Description

The User mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use User subcommands to create a local and remote user accounts, to add, change, or delete the roles for a user account, and to delete a user account. The local user accounts are managed by the Enterprise Controller; remote user accounts are managed by a directory server.

Type the user command at the command line prompt to enter User mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

add_local_user -u|--user username -r|--role role[,role2,..,rolen]

Registers a user account that exists on the Enterprise Controller's host system as an Oracle Enterprise Manager Ops Center user account with the specified role.

configureds

Starts a submode that defines a new directory server or modifies an existing directory server. Use the commit subcommand to complete the definition of the directory server and return to User mode.

- set name=directory_server.

- set hostname=hostname.

- set use_ssl=[false|true]. Default is false.

- set port=portID.

- set root_suffix=suffix.

- set user=credential.

- set password=credential.

- set user_dn=user_dn.

- set user_scope=scope to define the search path through the hierarchy. A scope can be base, one, sub.

- set search_filter=filter to the criteria for the search.

- unset [name|hostname|use_ssl|port|password|root_suffix|user_dn|user_scope|search_filter].

- reset to restore the values of the properties without changes.

- show to show the current values for each property.

delete_local_user -u|--user username

Removes the user account.

get_directory_servers [-d|--details]

Displays a list of directory servers and their identifiers.

get_ds_users -d|--directory directory_server [-r|--roles role[,role2,..,rolen]]

Displays a list of user accounts managed by the specified directory server. You can restrict the list to user accounts with the specified role. Use the get_directory_servers subcommand to see available directory servers.

grant_local_role -u|--user username -r|--role role[,role2,..,rolen]

Adds the specified roles to the specified user account.

remove_directory_service -d|--directory directory_server

Removes the specified directory server's access to the Enterprise Controller's cache. The user accounts in the directory server do not have access to Oracle Enterprise Manager Ops Center.

replicate_user_roles -u|--user username -r|--role username

Copies the roles of the specified user account to the target or recipient user account.

revoke_local_role -u|--user username -r|--role role[,role2,..,rolen]

Removes the specified roles from the user account.

show_all_local_roles

Displays a list of role types that are available in the Enterprise Controller.

show_local_users [-r|--roles role[,role2,..,rolen]]

Displays a list of user accounts that are registered in the Enterprise Controller. You can restrict the list to user accounts with the specified role.

show_local_user_roles -u|--user username

Displays the roles assigned to the specified user account.

sync_all_ds_users -d|--directory directory_server

Synchronizes the information about user accounts on the specified directory server with the cache in the Enterprise Controller.

sync_ds_user -d|--directory directory_server -u|--user username

Synchronizes the information the specified user account on the specified directory server with the cache in the Enterprise Controller.

Options

-d

- With the get_ds_users, remove_directory_service, sync_all_ds_users, and sync_ds_user commands, this option specifies the name of a directory server. The option can also be invoked as --directory.

- With the get_directory_servers command, this option includes detailed information. The option can also be invoked as --details.

-r

- With the add_local_user, grant_local_role, revoke_local_role, get_ds_users, and show_local_users commands, this option specifies the level of access and control that the user account has, according to the following roles:
ASSET_ADMIN
CLOUD_ADMIN
CLOUD_USER
FAULT_ADMIN
NETWORK_ADMIN
OPS_CENTER_ADMIN
PROFILE_PLAN_ADMIN
READ
REPORT_ADMIN
ROLE_ADMIN
SECURITY_ADMIN
SERVER_DEPLOYMENT_ADMIN
STORAGE_ADMIN
SUPERCLUSTER_ADMIN
UPDATE_ADMIN
UPDATE_SIM_ADMIN
USER_ADMIN
VIRT_ADMIN

The option can also be invoked as --role with the add_local_user, grant_local_role, revoke_local_role commands, or as --roles with the get_ds_users, and show_local_users commands.

- With the replicate_user_roles command, this option specifies a target or recipient user account. The option can also be invoked as --role.

-u|--user

Specifies the account name.

Operands

directory_server

Name of the directory server that provides remote user accounts to Oracle Enterprise Manager Ops Center.

role[,role2,...,rolen

Identifier for a type of access and control.

username

Name of the account.

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1) osimage(1), osprofile(1), reports(1), serverpools(1), stats(1), update(1), virtualization(1).

virtualization

Command to initiate the Virtualization mode and to use its subcommands.

Synopsis

list_guests -C|--container-on ObjectName
list_hosts
startup [-z|--zonename zonename -S|--source-on ObjectName | -Z|--zone-on ObjectName] -D|--destination-on  ObjectName

Description

The Virtualization mode is one of a set of modes provided by the Enterprise Manager Ops Center. Use the Virtualization subcommands to manage virtual hosts and virtual machines.

Type the virtualization command at the command line prompt to enter Virtualization mode. Type the end command to stop the mode and to return to the command line prompt.

Subcommands

list_guests -C|--container-on ObjectName

Lists the non-global zones for the global zone specified by ObjectName and the following information:

- Name: A user-friendly name. Do not use this name to specify a non-global zone.

- Type: either zone or ZONE

- State: RUNNING

- Migratable: True or False

- ObjectName: A fully-qualified name for a non-global zone.

list_hosts

Lists the global zones and the following information:

- Name: A user-friendly name. Do not use this name to specify a global zone.

- Type: either zone or ZONE

- Health: OK

- Reach: True or False

- ObjectName: A fully-qualified name for a global zone.

startup [-z|--zonename zonename -S|--source-on ObjectName | -Z|--zone-on ObjectName] -D|--destination-on ObjectName

Detaches a non-global zone from its non-functioning global zone and attaches the non-global zone to a different global zone. An administrator uses this subcommand to recover a non-global zone. Because Ops Center cannot check a global zone that is not reachable, the administrator must verify that the destination global zone is compatible with the source global zone: have the same release levels, use the same storage library to store zone metadata, and can both be reached on the network.

Options

-C|--container-on

Non-global zones hosted by the global zone with the name ObjectName.

-D|--destination-on

Destination global zone with the name ObjectName that will host the recovered non-global zone.

-S|--source-on

Source global zone with the name ObjectName. This zone is not functioning so its guests, the non-global zones, need to be recovered.

-Z|--zone-on

Non-global zone with the name ObjectName that is moved from the source global zone to the destination global zone.

-z|--zonename

Global zone with name ObjectName.

Operands

ObjectName

Name of a global or non-global zone, as shown in output of list_hosts command and list_guests command.

zonename

User-friendly name

Examples

Example 1   Display all the global zones

EnterpriseController/virtualization > list_hosts
Name        |     Type    |    Health   |  Reachable  |                                   ObjectName                              |                       UUID        |
----------------------------------------------------------------------------------
gzhost36    |     zone    |      OK     |    False    |           com.sun.hss.domain:type=xVMServer,name=NORM-NORM-localhost           |       2b7c71ac-70ab-48a2-a2f2-ac291e580c39
gzhost44    |     zone    |      OK     |    True    |           com.sun.hss.domain:type=xVMServer,name=NORM-NORM-localhost-4           |       3b6c61ab-50ab-34a1-b2d2-bd253e632c45

Example 2   Display all the non-global zones hosted by gz44

EnterpriseController/virtualization > list_guests -C com.sun.hss.domain:type=xVMServer,name=NORM-NORM-localhost
Name        |         Type        |    State    |  Migratable |                                   ObjectName                                   |
----------------------------------------------------------------------------------
test      |         ZONE        |   RUNNING   |    True    | com.sun.hss.domain:type=Server,name=NORM-07e91405-8313-43ec-9671-dc320989866e

Example 3   Move the non- global zone ngz from gz44 to gz36

EnterpriseController/virtualization > startup -Z com.sun.hss.domain:type=Server,name=NORM-07e91405-8313-43ec-9671-dc320989866e -D com.sun.hss.domain:type=xVMServer,name=NORM-NORM-localhost

See Also

oc(5), certificates(1), collisions(1), controllers(1), credentials(1), deploy(1), deploy-setup(1), discover(1), fwimage(1), fwprofile(1), gear(1), groups(1), incidents(1), jobs(1), monitoring(1), networks(1), notifications(1) osimage(1), osprofile(1),reports(1), serverpools(1), stats(1), update(1), user(1).

Index
A  C  F  H  I  J  M  N  O  P  R  S  U  V

A

asset management commands

See assets

assets

adding an asset to a group, 1.6.11.7

applying an update profile to an OS asset, 1.6.22.16

deleting an asset, 1.6.10.8

managing an asset, 1.6.10.5

modifying an OS asset, 1.6.22.15

moving an asset from one group to another, 1.6.11.9

powering off the assets in a group, 1.6.11.12

powering on the assets in a group, 1.6.11.11

removing an asset from a group, 1.6.11.8

setting the maintenance mode of an asset, 1.6.10.7

unmanaging an asset, 1.6.10.6

viewing an asset, 1.6.10.2

viewing assets associated to a partition, 1.6.19.7

viewing jobs associated with an asset, 1.6.10.4

C

CLI

man pages, 2

access, 1.2

connecting from a remote system, 1.2.3

defining user variables, 1.2.5

invoking the command line interface, 1.2.1

starting from the enterprise controller, 1.2.2

using the CLI, 1.2.4

using the CLI one-liner, 1.2.6

oc command, 2 command scripts, 1.5 features, 1.1

administration, 1.1.4

asset discovery, management, and grouping, 1.1.1

firmware provisioning, 1.1.3

OS provisioning and patching, 1.1.2

general commands, 1.3

checking connectivity, 1.3.1

disconnecting from Oracle Enterprise Manager Ops Center, 1.3.12

displaying a man page, 1.3.10

displaying user configuration, 1.3.2

ending a mode, 1.3.11

exiting the CLI, 1.3.13

recording console input and output, 1.3.4

reviewing commands, 1.3.9

setting the user environment, 1.3.3

using a source file, 1.3.5

viewing help, 1.3.8

viewing the version, 1.3.6

waiting for a job to complete, 1.3.7

modes

certificates, 1.6.1

collisions, 1.6.2

controllers, 1.6.3

credentials, 1.6.4

deploy, 1.6.6

deploy-setup, 1.6.5

discover, 1.6.7

FWImage, 1.6.8

FWProfile, 1.6.9

gear, 1.6.10

groups, 1.6.11

incidents, 1.6.12

jobs, 1.6.13

monitoring, 1.6.14

networks, 1.6.15

notifications, 1.6.16

OSImage, 1.6.17

OSProfile, 1.6.18

reports, 1.6.19

server pools, 1.6.20

stats, 1.6.21

update, 1.6.22

user, 1.6.23

virtualization, 1.6.24

See also CLI modes, 1.6.25

universal output filters, 1.4 CLI modes, 1.6

certificates

adding, 1.6.1.2

deleting, 1.6.1.3

viewing, 1.6.1.1

collisions

reserving MAC addresses, 1.6.2.4

verifying, 1.6.2.2

viewing, 1.6.2.1

controllers

evacuating assets from a failed proxy controller, 1.6.3.2

viewing, 1.6.3.1

equivalent BUI actions, 1.6.25.1

credentials

modifying details, 1.6.4.2

viewing, 1.6.4.1

equivalent BUI actions, 1.6.25.2

deploy

adding attributes to a deployment plan, 1.6.6.3

applying a deployment plan, 1.6.6.5

setting the attributes of a deployment plan, 1.6.6.2

testing a deployment plan, 1.6.6.4

viewing the plan, 1.6.6.1

equivalent BUI actions, 1.6.25.4

deploy-setup

selecting a deployment plan, 1.6.5.2

selecting a target asset, 1.6.5.3

starting mode, 1.6.5.1

equivalent BUI actions, 1.6.25.3

discover

creating a discovery job, 1.6.7.2

discovering an ALOM service processor, 1.6.7.5

discovering an ILOM service processor, 1.6.7.4

discovering an OS, 1.6.7.3

executing discovery profiles, 1.6.7.12

starting mode, 1.6.7.1

viewing discovery profile credentials, 1.6.7.9

viewing discovery profiles, 1.6.7.6

viewing discovery ranges, 1.6.7.7, 1.6.7.10

viewing driver credentials, 1.6.7.8

viewing networks, 1.6.7.11

equivalent BUI actions, 1.6.25.5

FWImage

creating a firmware image, 1.6.8.3

deleting a firmware image, 1.6.8.5

starting mode, 1.6.8.1

updating a firmware image, 1.6.8.4

viewing firmware images, 1.6.8.2

equivalent BUI actions, 1.6.25.6

FWProfile

checking the status of a firmware profile, 1.6.9.3

creating a firmware profile, 1.6.9.4

deleting a firmware profile, 1.6.9.6

starting mode, 1.6.9.1

updating a firmware profile, 1.6.9.5

viewing firmware profiles, 1.6.9.2

equivalent BUI actions, 1.6.25.7

gear

changing locator lights, 1.6.10.14

checking firmware compliance, 1.6.10.12

deleting an asset, 1.6.10.8

enabling or disabling notifications, 1.6.10.15

managing an asset, 1.6.10.5

powering off a server or chassis, 1.6.10.16

powering on a server or chassis, 1.6.10.17

provisioning an OS, 1.6.10.13

rebooting an OS, 1.6.10.10

refreshing a server, 1.6.10.19

reinstalling an agent controller on an OS, 1.6.10.9

resetting a server or chassis, 1.6.10.18

setting the maintenance mode of an asset, 1.6.10.7

starting mode, 1.6.10.1

unmanaging an asset, 1.6.10.6

updating asset information, 1.6.10.3

updating firmware, 1.6.10.11

viewing assets, 1.6.10.2

viewing jobs associated with assets, 1.6.10.4

equivalent BUI actions, 1.6.25.8

groups

adding an asset to a group, 1.6.11.7

creating, 1.6.11.5

deleting a group, 1.6.11.10

moving an asset from one group to another group, 1.6.11.9

powering off the assets in a group, 1.6.11.12

powering on the assets in a group, 1.6.11.11

removing an asset from a group, 1.6.11.8

resetting servers in a group, 1.6.11.13

starting mode, 1.6.11.1

updating group attributes, 1.6.11.6

viewing, 1.6.11.2

viewing group memberships, 1.6.11.4

viewing members of a group, 1.6.11.3

equivalent BUI actions, 1.6.25.9

incidents

acknowledging an, 1.6.12.5

adding an annotation to one or more incidents, 1.6.12.6

assigning, 1.6.12.7

closing, 1.6.12.8

viewing, 1.6.12.2

viewing alerts associated with, 1.6.12.4

viewing incident details, 1.6.12.3

equivalent BUI actions, 1.6.25.10

jobs

deleting, 1.6.13.5

repeating a job on failed targets, 1.6.13.4

starting a job, 1.6.13.3

starting mode, 1.6.13.1

stopping, 1.6.13.6

viewing, 1.6.13.2

equivalent BUI actions, 1.6.25.11

monitoring

disabling monitoring, 1.6.14.4

enabling monitoring, 1.6.14.3

list monitoring state, 1.6.14.2

starting mode, 1.6.14.1

networks

starting mode, 1.6.15.1

viewing list of managed networks, 1.6.15.2

notifications

deleting, 1.6.16.3

starting mode, 1.6.16.1

viewing, 1.6.16.2

equivalent BUI actions, 1.6.25.12

OSImage

deleting an OS image, 1.6.17.4

importing an OS image, 1.6.17.3

starting mode, 1.6.17.1

viewing OS images, 1.6.17.2

equivalent BUI actions, 1.6.25.13

OSProfile

copying an OS profile, 1.6.18.6

deleting an OS profile, 1.6.18.7

exporting an OS profile, 1.6.18.5

importing a JET template, 1.6.18.3

importing an OS profile, 1.6.18.4

starting mode, 1.6.18.1

viewing OS profiles, 1.6.18.2

equivalent BUI actions, 1.6.25.14

reports

checking partitions, 1.6.19.8

checking the status of the reporting service, 1.6.19.2

converting partition samples to new format, 1.6.19.9

deleting a partition, 1.6.19.20

disabling automatic rollup and cleanup, 1.6.19.12

enabling automatic rollup and cleanup, 1.6.19.11

purging partitions samples with old format, 1.6.19.10

resetting a partition, 1.6.19.19

resetting rollup statistics, 1.6.19.17

setting the pause time, 1.6.19.18

starting manual cleanup, 1.6.19.14

starting manual rollup, 1.6.19.13

starting mode, 1.6.19.1

starting the reporting service, 1.6.19.3

stopping the reporting service, 1.6.19.4

viewing assets associated to a partition, 1.6.19.7

viewing detailed partition information, 1.6.19.6

viewing detailed rollup and cleanup information, 1.6.19.15

viewing partitions, 1.6.19.5

viewing rollup and cleanup statistics, 1.6.19.16

equivalent BUI actions, 1.6.25.15

ServerPools, 1.6.20

removing a member from a server pool, 1.6.20.4

starting mode, 1.6.20.1

viewing members of a server pool, 1.6.20.3

viewing server pools, 1.6.20.2

equivalent BUI actions, 1.6.25.16

stats, 1.6.21

starting mode, 1.6.21.1

viewing statistics, 1.6.21.2

update

adding a configuration file, 1.6.22.27

adding a file to a distribution, 1.6.22.22

adding a local action, 1.6.22.24

adding a local category, 1.6.22.25

applying an update profile to an OS asset, 1.6.22.16

changing to connected mode, 1.6.22.13

changing to disconnected mode, 1.6.22.14

checking connectivity to the knowledge base, 1.6.22.8

checking inventory, 1.6.22.7

checking the connection mode, 1.6.22.12

creating a historical snapshot, 1.6.22.17

creating a profile, 1.6.22.19

creating a profile from inventory, 1.6.22.20

deleting a component, 1.6.22.26

deleting a profile, 1.6.22.21

deleting a snapshot, 1.6.22.18

modifying an OS asset, 1.6.22.15

querying job history, 1.6.22.9

querying job status, 1.6.22.10

searching inventory, 1.6.22.6

setting a component file, 1.6.22.28

starting mode, 1.6.22.1

uploading a knowledge base bundle, 1.6.22.11

uploading a local software in bulk from a directory, 1.6.22.23

viewing OS distributions, 1.6.22.4

viewing OS update policies, 1.6.22.2

viewing OS update profiles, 1.6.22.3

viewing snapshots, 1.6.22.5

equivalent BUI actions, 1.6.25.17

user

adding a directory server, 1.6.23.9

adding a user to the enterprise controller, 1.6.23.5

deleting a, 1.6.23.15

granting roles to a, 1.6.23.6

removing a directory server, 1.6.23.14

removing roles from a, 1.6.23.8

replicating user roles, 1.6.23.7

starting mode, 1.6.23.1

synchronizing a single user, 1.6.23.13

synchronizing all remote users, 1.6.23.12

viewing directory servers, 1.6.23.10

viewing remote users, 1.6.23.11

viewing role types, 1.6.23.3

viewing user roles, 1.6.23.4

viewing users, 1.6.23.2

equivalent BUI actions, 1.6.25.18

virtualization, 1.6.24

migrating a non-global zone, 1.6.24.4

starting mode, 1.6.24.1

viewing guests, 1.6.24.3

viewing hosts, 1.6.24.2

equivalent BUI actions, 1.6.25.19

command line interface

See CLI

F

firmware

checking compliance, 1.6.10.12

creating a firmware, 1.6.9.4

updating, 1.6.10.11

H

hardware

changing locator lights, 1.6.10.14

powering off a server or chassis, 1.6.10.16

powering on a server or chassis, 1.6.10.17

refreshing a server, 1.6.10.19

resetting a server or chassis, 1.6.10.18, 1.6.10.18

I

incidents

See CLI modes, incidents

J

jobs

See CLI modes, jobs

M

monitoring

See CLI modes, monitoring

N

networks

See CLI modes, networks

notifications

See CLI modes, notifications

O

operating systems

See OS

OS

discovering an, 1.6.7.3

managing OS images, 1.6.17

managing OS profiles, 1.6.18

managing OS updates, 1.6.22

provisioning an, 1.6.10.13

provisioning and patching an, 1.1.2

rebooting an, 1.6.10.10

reinstalling an agent controller on an, 1.6.10.9

P

profiles

checking the status of a firmware profile, 1.6.9.3

creating an OS profile, 1.6.22.19

creating an OS profile from inventory, 1.6.22.20

deleting a firmware profile, 1.6.9.6

deleting an OS profile, 1.6.22.21

executing a discovery profile, 1.6.7.12

OS profiles, 1.6.18

starting firmware profile mode, 1.6.9.1

updating a firmware profile, 1.6.9.5

viewing a discovery profile, 1.6.7.6

viewing a firmware profile, 1.6.9.2

viewing discovery profile credentials, 1.6.7.9

viewing OS Update profiles, 1.6.22.3

R

reports

See CLI mode, reports

S

server pools

See CLI modes, ServerPools

statistics

See CLI modes, stats

U

user, user management

See CLI modes, user

V

virtualization

See CLI modes, virtualization

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2015, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.