Raritan / Server Technology Xerus™ PDU JSON-RPC API: pdumodel::OutletGroupManager Interface Reference

Raritan / Server Technology Xerus™ PDU JSON-RPC API

Classes | Public Member Functions | Public Attributes | List of all members
pdumodel::OutletGroupManager Interface Reference

Outlet group manager interface. More...

`import"OutletGroupManager.idl";`

## Classes
struct | GroupCreatedEvent
| Event: A new outlet group has been created. More...
struct | GroupDeletedEvent
| Event: An outlet group has been deleted. More...

## Public Member Functions
int | createGroup (in string name, in vector< Outlet > members, out OutletGroup group)
| Create a new outlet group. More...
map< int, OutletGroup > | getAllGroups ()
| Retrieve the list of outlet groups. More...
int | getGroup (in int id, out OutletGroup group)
| Retrieve a specific outlet group. More...
int | deleteGroup (in int id)
| Delete an outlet group. More...

## Public Attributes
constant int | ERR_INVALID_ARGUMENT = 1
constant int | ERR_NO_SUCH_ID = 2
constant int | ERR_MAX_GROUP_COUNT_REACHED = 3

## Detailed Description

Outlet group manager interface.

## Member Function Documentation

## ◆ createGroup()

int pdumodel::OutletGroupManager::createGroup | ( | in string | name,
|  | in vector< Outlet > | members,
|  | out OutletGroup | group
| ) |  |

Create a new outlet group.

Parameters

  name | New group name
  members | List of member outlets
  group | Result: Reference to newly created group; null in case of error

Returns
  0 if OK
  1 if any parameters are invalid
  3 if the maximum number of groups has been reached

## ◆ deleteGroup()

int pdumodel::OutletGroupManager::deleteGroup | ( | in int | id | ) |

Delete an outlet group.

Parameters

  id | The ID of the group to delete

Returns
  0 if OK
  2 if no group with the given ID exists

## ◆ getAllGroups()

map<int, OutletGroup> pdumodel::OutletGroupManager::getAllGroups | ( |  | ) |

Retrieve the list of outlet groups.

Returns
  Map of outlet groups, indexed by group ID

## ◆ getGroup()

int pdumodel::OutletGroupManager::getGroup | ( | in int | id,
|  | out OutletGroup | group
| ) |  |

Retrieve a specific outlet group.

Parameters

  id | The ID of the requested group
  group | Result: requested outlet group; null if not found

Returns
  0 if OK
  2 if no group with the given ID exists

The documentation for this interface was generated from the following file:

- OutletGroupManager.idl