GetFreePhysicalVolumes_VirtualIOServer Job

The GetFreePhysicalVolumes job returns the free physical volumes that belong to Virtual I/O Server (VIOS) on which it was queried. It also provides the FibreChannelBackedOnly option to filter the Fibre-Channel-backed physical volumes.

About this task

Resource

/rest/api/uom/VirtualIOServer/{VirtualIOServer_UUID}/do/GetFreePhysicalVolumes

Since: Version 1_3_0

Request

The FibreChannelBackedOnly is the only optional attribute. When this parameter value is set to true, the job returns a list of physical volumes that are fibre channel backed and available for usage. If the value is set to false, the job returns a list of all physical volumes that are available for usage.

Table 1. Request parameter
Request parameter	Description
FibreChannelBackedOnly	To filter only Fibre-Channel-backed physical volume (PV).

Response

This job returns the PhysicalVolumeCollection parameter that contains free physical volumes and also the valid job status values such as Complete_Ok and Failed_Before_Complete.

Table 2. Response parameters
Response parameter	Description
result	PhysicalVolumeCollection that contains free PVs.

Sample Job Request(s)

 <JobRequest:JobRequest xmlns:JobRequest="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"
 xmlns="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/" 
xmlns:ns2="http://www.w3.org/XML/1998/namespace/k2" schemaVersion="V1_3_0">
    <Metadata>
        <Atom/>
    </Metadata>
    <RequestedOperation kb="CUR" kxe="false" schemaVersion="V1_3_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <OperationName kb="ROR" kxe="false">GetFreePhysicalVolumes</OperationName>
        <GroupName kb="ROR" kxe="false">VirtualIOServer</GroupName>
    </RequestedOperation>
    <JobParameters kxe="false" kb="CUR" schemaVersion="V1_3_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <JobParameter schemaVersion="V1_3_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">FibreChannelBackedOnly</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>