The ironic.api.controllers.v1.types Module

The ironic.api.controllers.v1.types Module

class ironic.api.controllers.v1.types.BooleanType[source]

Bases: wsme.types.UserType

A simple boolean type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
class ironic.api.controllers.v1.types.JsonPatchType(**kw)[source]

Bases: wsme.types.Base

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

static internal_attrs()[source]

Returns a list of internal attributes.

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

classmethod non_removable_attrs()[source]

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 validate(patch)[source]
class ironic.api.controllers.v1.types.JsonType[source]

Bases: wsme.types.UserType

A simple JSON type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
class ironic.api.controllers.v1.types.ListType[source]

Bases: wsme.types.UserType

A simple list type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]

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
class ironic.api.controllers.v1.types.LocalLinkConnectionType[source]

Bases: wsme.types.UserType

A type describing local link connection.

basetype

alias of DictType

static frombasetype(value)[source]
static validate(value)[source]

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.
class ironic.api.controllers.v1.types.MacAddressType[source]

Bases: wsme.types.UserType

A simple MAC address type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
class ironic.api.controllers.v1.types.NameType[source]

Bases: wsme.types.UserType

A simple logical name type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
class ironic.api.controllers.v1.types.UuidOrNameType[source]

Bases: wsme.types.UserType

A simple UUID or logical name type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
class ironic.api.controllers.v1.types.UuidType[source]

Bases: wsme.types.UserType

A simple UUID type.

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
class ironic.api.controllers.v1.types.VifType[source]

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

basetype

alias of unicode

static frombasetype(value)[source]
static validate(value)[source]
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.