man pages section 3: Remote Administration Daemon Module Interfaces

dlmgr (3rad)

Name

dlmgr - API for datalink and flow control

Synopsis

interface Datalink
setProperty(string properties,
integer flags);

Property[] getProperty(string properties);

StatValue getStat(StatType stattype);

Description

DLMGR(3rad)                 RAD Module Definitions                 DLMGR(3rad)



NAME
       dlmgr - API for datalink and flow control

SYNOPSIS
   interface Datalink
       setProperty(string properties,
                   integer flags);

       Property[] getProperty(string properties);

       StatValue getStat(StatType stattype);

DESCRIPTION
       API com.oracle.solaris.rad.dlmgr

       The following are sample python clients which illustrate some simple
       interactions with the module.

       Example 1. Get priority property from net1

           import rad.client as radcli
           import rad.connect as radcon
           import rad.bindings.com.oracle.solaris.rad.dlmgr_1 as dlmgr

           with radcon.connect_unix() as rc:
               pat = radcli.ADRGlobPattern({"name" : "net1"})
               net1 = rc.get_object(dlmgr.Datalink(), pat)
               priority = net1.getProperty("priority")


       Example 2. Set maxbw property on net2

           import rad.client as radcli
           import rad.connect as radcon
           import rad.bindings.com.oracle.solaris.rad.dlmgr_1 as dlmgr

           with radcon.connect_unix() as rc:
               pat = radcli.ADRGlobPattern({"name" : "net2"})
               net2 = rc.get_object(dlmgr.Datalink(), pat)
               net2.setProperty("maxbw=200", 1)


INTERFACES
   interface Datalink
       The Datalink interface is an administrative API tha can be used to
       adminster datalinks.

       Datalink Methods
           setProperty(string properties, integer flags)

               set the values of list of datalink properites specified

               Set the values of the list of datalink properties specified. If
               one of the properties or values are invalid, none of the
               properties will be set.

               Arguments:

               properties -- comma separated list of name-value pairs of
               properties and the values to which they are to be set (e.g.,
               maxbw=200,priority=high)

               flags -- option flags for setting datalink properties
               0x00000001 - set temporary property on active system 0x00000002
               - set property to persist across reboot

               Error:

               DatalinkError

           Property[] getProperty(string properties)

               Get the information of datalink properites

               Get the permission and the current, default and possible values
               of the list of datalink properties specified.

               Arguments:

               properties -- comma separated list of of properties whose
               values are to be retrieved.

               Result:

               Property[]

               Error:

               DatalinkError

           StatValue getStat(StatType stattype)

               get the stats

               Arguments:

               stattype -- the type of stat to get

               Result:

               StatValue (nullable)

               Error:

               DatalinkError

ENUMERATED TYPES
       enum Permission -- permission of properties

           READ (1) -- read permission

           WRITE (2) -- write permission

           READWRITE (3) -- read and write permission

           UNKNOWN (4) -- permission unknown

       enum StatType -- type of stat

           LINK (0) -- link stat

STRUCTURE TYPES
       struct DatalinkError

           Fields:

           integer err -- dladm_status_t error codes as defined in libdladm.h.

           string errmsg -- human readable error message corresponding to
           error code above.

       struct Property

           A datalink property.

           Fields:

           string propname -- The name of the datalink property

           Permission perm -- permission to read/wirte the property

           string current (nullable) -- The current value of the property.

           string effective (nullable) -- The effective value of the property.

           string persistent (nullable) -- The persistent value of the
           property.

           string defvalue (nullable) -- The default value of the property.

           string possible (nullable) -- A comma-separated list of the value
           the property can have. If the values span a numeric range, min-max
           may shown as shorthand.

       struct LinkStat

           Fields:

           ulong ipackets

           ulong rbytes

           ulong idrops

           ulong idropbytes

           ulong obytes

           ulong opackets

           ulong odrops

           ulong odropbytes

       struct StatValue

           Fields:

           StatType discriminant

           LinkStat linkstat (nullable)

       Version: (1.0)

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +--------------------+-------------------------+
       |  ATTRIBUTE TYPE    |     ATTRIBUTE VALUE     |
       +--------------------+-------------------------+
       |Availability        | system/management/rad/* |
       +--------------------+-------------------------+
       |Interface Stability | Private                 |
       +--------------------+-------------------------+

SEE ALSO
       rad(1M)



SunOS 5.11                        2017-01-11                       DLMGR(3rad)