ironic.api.controllers.v1.portgroup module¶

service None

Bases: ironic.api.controllers.base.APIBase

API representation of a portgroup.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a portgroup.

classmethod Portgroup.convert_with_links(rpc_portgroup, fields=None)¶

Add links to the portgroup.

classmethod Portgroup.sample(expand=True)¶

Return a sample of the portgroup.

service None

Bases: ironic.api.controllers.v1.collection.Collection

API representation of a collection of portgroups.

static PortgroupCollection.convert_with_links(rpc_portgroups, limit, url=None, fields=None, **kwargs)¶

classmethod PortgroupCollection.sample()¶

Return a sample of the portgroup.

service None

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

static PortgroupPatchType.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.

service None

Bases: pecan.rest.RestController

REST controller for portgroups.

PortgroupsController.delete(portgroup_ident)[source]¶

Delete a portgroup.

Parameters:	portgroup_ident – UUID or logical name of a portgroup.

PortgroupsController.detail(node=None, address=None, marker=None, limit=None, sort_key='id', sort_dir='asc')[source]¶

Retrieve a list of portgroups with detail.

Parameters:

node – UUID or name of a node, to get only portgroups for that node. address – MAC address of a portgroup, to get the portgroup which has this MAC address. marker – pagination marker for large data sets. limit – maximum number of resources to return in a single result. This value cannot be larger than the value of max_limit in the [api] section of the ironic configuration, or only max_limit resources will be returned. sort_key – column to sort results by. Default: id. sort_dir – direction to sort. “asc” or “desc”. Default: asc.

PortgroupsController.get_all(node=None, address=None, marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)[source]¶

Retrieve a list of portgroups.

Parameters:

node – UUID or name of a node, to get only portgroups for that node. address – MAC address of a portgroup, to get the portgroup which has this MAC address. marker – pagination marker for large data sets. limit – maximum number of resources to return in a single result. This value cannot be larger than the value of max_limit in the [api] section of the ironic configuration, or only max_limit resources will be returned. sort_key – column to sort results by. Default: id. sort_dir – direction to sort. “asc” or “desc”. Default: asc. fields – Optional, a list with a specified set of fields of the resource to be returned.

PortgroupsController.get_one(portgroup_ident, fields=None)[source]¶

Retrieve information about the given portgroup.

Parameters:	portgroup_ident – UUID or logical name of a portgroup. fields – Optional, a list with a specified set of fields of the resource to be returned.

PortgroupsController.patch(portgroup_ident, patch)[source]¶

Update an existing portgroup.

Parameters:	portgroup_ident – UUID or logical name of a portgroup. patch – a json PATCH document to apply to this portgroup.

PortgroupsController.post(portgroup)[source]¶

Create a new portgroup.

Parameters:	portgroup – a portgroup within the request body.