The ironic.api.controllers.v1.portgroup Module

class ironic.api.controllers.v1.portgroup.Portgroup(**kwargs)

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 convert_with_links(rpc_portgroup, fields=None)

Add links to the portgroup.

classmethod sample(expand=True)

Return a sample of the portgroup.

class ironic.api.controllers.v1.portgroup.PortgroupCollection(**kwargs)

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

API representation of a collection of portgroups.

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

classmethod sample()

Return a sample of the portgroup.

class ironic.api.controllers.v1.portgroup.PortgroupPatchType(**kw)

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

static internal_attrs()

class ironic.api.controllers.v1.portgroup.PortgroupsController(node_ident=None)

Bases: pecan.rest.RestController

REST controller for portgroups.

delete(*args, **kwargs)

Delete a portgroup.

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

detail(*args, **kwargs)

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.

get_all(*args, **kwargs)

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.

get_one(*args, **kwargs)

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.

patch(*args, **kwargs)

Update an existing portgroup.

Parameters:

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

post(*args, **kwargs)

Create a new portgroup.

Parameters:portgroup – a portgroup within the request body.