Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
RFC 1213 Parameters [OPENAPI_1213]

Macros

#define OPEN_RFC1213_PARAM_SIZE   256
 

Functions

open_error_t openapi1213SystemSysContactGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_contact)
 Get the system contact information. More...
 
open_error_t openapi1213SystemSysContactSet (openapiClientHandle_t *client_handle, open_buffdesc *sys_contact)
 Set the system contact information. More...
 
open_error_t openapi1213SystemSysDescrGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_descr)
 Get the system description. More...
 
open_error_t openapi1213SystemSysLocationGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_location)
 Get the system location. More...
 
open_error_t openapi1213SystemSysLocationSet (openapiClientHandle_t *client_handle, open_buffdesc *sys_location)
 Set the system location. More...
 
open_error_t openapi1213SystemSysNameGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_name)
 Get the system name. More...
 
open_error_t openapi1213SystemSysNameSet (openapiClientHandle_t *client_handle, open_buffdesc *sys_name)
 Set the system name. More...
 

Detailed Description

Function Documentation

open_error_t openapi1213SystemSysContactGet ( openapiClientHandle_t client_handle,
open_buffdesc sys_contact 
)

Get the system contact information.

Parameters
[in]client_handleClient handle from registration API
[out]sys_contactSystem contact
minimumbuffer size OPEN_RFC1213_PARAM_SIZE
Return values
OPEN_E_NONEif system contact get is successful.
OPEN_E_FAILif system contact get has failed.
OPEN_E_PARAMinvalid sys_contact parameter

OpEN API Version: 1.7

Examples:
rfc1213_example.c.
open_error_t openapi1213SystemSysContactSet ( openapiClientHandle_t client_handle,
open_buffdesc sys_contact 
)

Set the system contact information.

Parameters
[in]client_handleClient handle from registration API
[in]sys_contactSystem contact
maximumbuffer size OPEN_RFC1213_PARAM_SIZE - 1
Return values
OPEN_E_NONEif system contact set is successful.
OPEN_E_FAILif system contact set has failed.
OPEN_E_PARAMinvalid sys_contact parameter
Note
The textual identification of the contact person for this managed node, together with information on how to contact this person.

OpEN API Version: 1.7

Examples:
rfc1213_example.c.
open_error_t openapi1213SystemSysDescrGet ( openapiClientHandle_t client_handle,
open_buffdesc sys_descr 
)

Get the system description.

Parameters
[in]client_handleClient handle from registration API
[out]sys_descrSystem description
minimumbuffer size OPEN_RFC1213_PARAM_SIZE
Return values
OPEN_E_NONEif system description get is successful.
OPEN_E_FAILif system description get failed.
OPEN_E_PARAMinvalid sys_descr parameter

OpEN API Version: 1.7

Examples:
rfc1213_example.c.
open_error_t openapi1213SystemSysLocationGet ( openapiClientHandle_t client_handle,
open_buffdesc sys_location 
)

Get the system location.

Parameters
[in]client_handleClient handle from registration API
[out]sys_locationSystem location
minimumbuffer size OPEN_RFC1213_PARAM_SIZE
Return values
OPEN_E_NONEif system location get is successful.
OPEN_E_FAILif system location get has failed.
OPEN_E_PARAMinvalid sys_location parameter

OpEN API Version: 1.7

Examples:
rfc1213_example.c.
open_error_t openapi1213SystemSysLocationSet ( openapiClientHandle_t client_handle,
open_buffdesc sys_location 
)

Set the system location.

Parameters
[in]client_handleClient handle from registration API
[in]sys_locationSystem location
maximumbuffer size OPEN_RFC1213_PARAM_SIZE - 1
Return values
OPEN_E_NONEif system location set is successful.
OPEN_E_FAILif system location set has failed.
OPEN_E_PARAMinvalid sys_location parameter
Note
The physical location of this node (e.g. 'telephone closet, 3rd floor')

OpEN API Version: 1.7

Examples:
rfc1213_example.c.
open_error_t openapi1213SystemSysNameGet ( openapiClientHandle_t client_handle,
open_buffdesc sys_name 
)

Get the system name.

Parameters
[in]client_handleClient handle from registration API
[out]sys_nameSystem name
minimumbuffer size OPEN_RFC1213_PARAM_SIZE
Return values
OPEN_E_NONEif system name get is successful.
OPEN_E_FAILif system name get has failed.
OPEN_E_PARAMinvalid sys_name parameter

OpEN API Version: 1.7

Examples:
rfc1213_example.c.
open_error_t openapi1213SystemSysNameSet ( openapiClientHandle_t client_handle,
open_buffdesc sys_name 
)

Set the system name.

Parameters
[in]client_handleClient handle from registration API
[in]sys_nameSystem name
maximumbuffer size OPEN_RFC1213_PARAM_SIZE - 1
Return values
OPEN_E_NONEif system name set is successful.
OPEN_E_FAILif system name set has failed.
OPEN_E_PARAMinvalid system name parameter
Note
An administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name.

OpEN API Version: 1.7

Examples:
rfc1213_example.c.