IVM os_install Command

Purpose

Performs network install operations on OS_install objects.

Syntax

Traditional usage:

OS_install {-o Operation} [ -a attr=value... ] {ObjectName}

For system plan installations (System Plan mode):

OS_install -i sysplan {-x sysplan.xml} [ -d ]

For listing OS_install objects (List mode):

OS_install -l [-v] [-t object_type | object_name]

Description

The OS_install command performs a network installation operation on an OS_install object. The type of operation is dependent on the type of object specified by the ObjectName parameter. The object pointed to by the ObjectName parameter can be one of three types: client, OS_Resource, or ControlHost. Command operations involve the creation and management of OS_install objects in order to network install an operation system onto a client machine.

OS_install can also be run in System Plan mode by passing the -i sysplan flag instead of specifying an operation. This provides the ability to combine multiple OS_install operations into a single XML document.

The List mode of OS_install is used to list the current configuration of objects in the OS_install environment.

Flags

-a attr=value	Assigns the specified value to the specified attribute. Operations lists the required and optional attributes for a specific operation.
-d	Destroys all OS_install objects created during System Plan mode after all operations have been completed.
-i sysplan	Specifies System Plan mode.
-l	Lists all OS_install objects in the environment by default.
-o Operation	Specifies an operation to perform on an OS_install object.
-t object_type \| object_name	Narrows the list returned by the -l flag to only objects of type object_type or to the single OS_install object specified by object_name.
-v	Displays the list returned by the -l flag.
-x sysplan.xml	Specifies the XML file that contains the system plan.

Operations

Operation	Description	Required Attributes	Optional Attributes
define_client [-a attr=value...] {ClientObjectName}	Defines a new client object.	ip_addr Client's IP address. mac_addr MAC address of client's network interface. gateway Client's IP gateway. subnet_mask Client's IP subnet mask.	adapter_speed Speed of client's network adapter. adapter_duplex Duplex setting of client's network adapter. lpar LPAR name to install client. profile LPAR profile to use for client. managed_system Name of managed system that contains LPAR. disk_location Location of disk to install client. ctrl_host Name of Hardware Control Host object for this client.
define_resource [-a attr=value...] {ResourceObjectName}	Defines a new OS_Resource object.	type AIX® or Linux® version Operating system version	location Absolute path where OS_Resource will reside. source Source of installation images. configfile Installation configuration file.
define_ctrl_host [-a attr=value...] {ControlHostObjectName}	Defines a new Hardware Control Host object.	communication_method ssh, rsh, or local hostname Host name of control host. type HMC or ivm	None.
allocate [-a attr=value...] {ClientObjectName}	Allocates an OS_Resource to a client object. Both objects must already exist in the OS_install environment. An error will occur if the client object has an OS_Resource already allocated to it.	os_resource Existing OS_Resource object to allocate to the client object.	None.
netboot {ClientObjectName}	Instructs the hardware control host of the client object to initiate a network boot.	None.	None.
monitor_installation {ClientObjectName}	Monitors the installation status of the client object.	None.	None.
deallocate {ClientObjectName}	Deallocates the OS_Resource that was allocated to the client object by an allocate operation.	None.	None.
remove {ObjectName}	Removes the object from the OS_install environment.	None.	None.

Exit Status

The following exit values are returned:

0	The command completed successfully.
>0	An error occurred.

Examples

To define a client object, enter a command similar to the following:

OS_install -o define_client -a ip_addr=128.0.64.117 
-a mac_addr=ab:cc:de:10:23:45 -a gateway=128.0.64.1 
-a subnet_mask=255.255.255.0 -a ctrl_host=myhmc -a lpar=AIX1 
-a profile=AIX1 -a managed_system=myMngSys myclient01

To define an OS_Resource object, enter a command similar to the following:

OS_install -o define_resource -a location=/images/AIX/53ML3 -a type=AIX 
-a version=53ML3 my53resource

To allocate the OS_Resource object defined in the preceding example to a client object, enter a command similar to the following:
```
OS_install -o allocate -a os_resource=my53resource myclient01
```
To deallocate the my53resource client object that was allocated in the preceding example, enter:
```
OS_install -o deallocate myclient01
```
To define a ControlHost object to be specified for the ctrl_host attribute, enter a command similar to the following:
```
OS_install -o define_ctrl_host -a type=ivm -a hostname=ivm_hostname 
-a communication_method=ssh myivm
```

To view a myclient01 installation, enter:

OS_install -o monitor_installation myclient01

To remove the definition of the my53resource object, enter:
```
OS_install -o remove my53resource
```
To remove the definition of the myclient01 object, enter:
```
OS_install -o remove myclient01
```
Note: If an OS_Resource object is specified, the remove operation also removes any OS images that exist in the file system directory specified by the object's location attribute.

Related Information

The lparnetboot command.