ironic.api.controllers.v1.types module¶

service None

Bases: wsme.types.UserType

A simple boolean type.

None¶

alias of builtins.str

static BooleanType.frombasetype(value)¶

static BooleanType.validate(value)¶

service None

Bases: wsme.types.Base

A complex type that represents a single json-patch operation.

static JsonPatchType.internal_attrs()¶

Returns a list of internal attributes.

Internal attributes can’t be added, replaced or removed. This method may be overwritten by derived class.

classmethod JsonPatchType.non_removable_attrs()¶

Returns a set of names of attributes that may not be removed.

Attributes whose ‘mandatory’ property is True are automatically added to this set. To add additional attributes to the set, override the field _extra_non_removable_attrs in subclasses, with a set of the form {‘/foo’, ‘/bar’}.

static JsonPatchType.validate(patch)¶

service None

Bases: wsme.types.UserType

A simple JSON type.

None

alias of builtins.str

static JsonType.frombasetype(value)¶

static JsonType.validate(value)¶

service None

Bases: wsme.types.UserType

A simple list type.

None

alias of builtins.str

static ListType.frombasetype(value)¶

static ListType.validate(value)¶

Validate and convert the input to a ListType.

Parameters:	value – A comma separated string of values
Returns:	A list of unique values (lower-cased), maintaining the same order

service None

Bases: wsme.types.UserType

A type describing local link connection.

None

alias of wsme.types.DictType

static LocalLinkConnectionType.frombasetype(value)¶

static LocalLinkConnectionType.validate(value)¶

Validate and convert the input to a LocalLinkConnectionType.

Parameters:	value – A dictionary of values to validate, switch_id is a MAC address or an OpenFlow based datapath_id, switch_info is an optional field.

For example:

{
   'switch_id': mac_or_datapath_id(),
   'port_id': 'Ethernet3/1',
   'switch_info': 'switch1'
}

Returns:	A dictionary.
Raises:	Invalid if some of the keys in the dictionary being validated are unknown, invalid, or some required ones are missing.

service None

Bases: wsme.types.UserType

A simple MAC address type.

None

alias of builtins.str

static MacAddressType.frombasetype(value)¶

static MacAddressType.validate(value)¶

service None

Bases: wsme.types.UserType

A simple logical name type.

None

alias of builtins.str

static NameType.frombasetype(value)¶

static NameType.validate(value)¶

service None

Bases: wsme.types.UserType

A simple UUID or logical name type.

None

alias of builtins.str

static UuidOrNameType.frombasetype(value)¶

static UuidOrNameType.validate(value)¶

service None

Bases: wsme.types.UserType

A simple UUID type.

None

alias of builtins.str

static UuidType.frombasetype(value)¶

static UuidType.validate(value)¶

service None

Bases: ironic.api.controllers.v1.types.JsonType

None

alias of builtins.str

static VifType.frombasetype(value)[source]¶

static VifType.validate(value)[source]¶