2.2.5.54 IpamTaskState

The IpamTaskState simple type is an enumeration that indicates the state of an IPAM task.

 <xs:simpleType name="IpamTaskState">
   <xs:restriction base="xsd:string">
     <xs:enumeration value="None" />
     <xs:enumeration value="Disabled" />
     <xs:enumeration value="Queued" />
     <xs:enumeration value="Ready" />
     <xs:enumeration value="Running" />
     <xs:enumeration value="Unknown" />
   </xs:restriction>
 </xs:simpleType>

The following table describes the various values of this type.

Value

Description

None

Unspecified or an invalid value.

Disabled

The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled.

Queued

Instances of the task are queued.

Ready

The task is ready to be executed, but no instances are queued or running.

Running

One or more instances of the task are running.

Unknown

The state of the task is unknown.