ironic.api.controllers.v1.portgroup module

ironic.api.controllers.v1.portgroup module

class ironic.api.controllers.v1.portgroup.PortgroupsController(*args, **kwargs)[source]

Bases: RestController

REST controller for portgroups.

delete(portgroup_ident)[source]

Delete a portgroup.

Parameters

portgroup_ident – UUID or logical name of a portgroup.

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.

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.

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.

invalid_sort_key_list = ['extra', 'internal_info', 'properties']
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.

post(portgroup)[source]

Create a new portgroup.

Parameters

portgroup – a portgroup within the request body.

Add links to the portgroup.

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.