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).