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.
open_error_t	openapi1213SystemSysContactSet (openapiClientHandle_t *client_handle, open_buffdesc *sys_contact)
	Set the system contact information.
open_error_t	openapi1213SystemSysDescrGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_descr)
	Get the system description.
open_error_t	openapi1213SystemSysLocationGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_location)
	Get the system location.
open_error_t	openapi1213SystemSysLocationSet (openapiClientHandle_t *client_handle, open_buffdesc *sys_location)
	Set the system location.
open_error_t	openapi1213SystemSysNameGet (openapiClientHandle_t *client_handle, open_buffdesc *sys_name)
	Get the system name.
open_error_t	openapi1213SystemSysNameSet (openapiClientHandle_t *client_handle, open_buffdesc *sys_name)
	Set the system name.

Detailed Description

Function Documentation

open_error_t openapi1213SystemSysContactGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	sys_contact
	)

Get the system contact information.

Parameters

[in]	client_handle	Client handle from registration API
[out]	sys_contact	System contact
	minimum	buffer size OPEN_RFC1213_PARAM_SIZE

Return values

OPEN_E_NONE	if system contact get is successful.
OPEN_E_FAIL	if system contact get has failed.
OPEN_E_PARAM	invalid 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_handle	Client handle from registration API
[in]	sys_contact	System contact
	maximum	buffer size OPEN_RFC1213_PARAM_SIZE - 1

Return values

OPEN_E_NONE	if system contact set is successful.
OPEN_E_FAIL	if system contact set has failed.
OPEN_E_PARAM	invalid 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_handle	Client handle from registration API
[out]	sys_descr	System description
	minimum	buffer size OPEN_RFC1213_PARAM_SIZE

Return values

OPEN_E_NONE	if system description get is successful.
OPEN_E_FAIL	if system description get failed.
OPEN_E_PARAM	invalid 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_handle	Client handle from registration API
[out]	sys_location	System location
	minimum	buffer size OPEN_RFC1213_PARAM_SIZE

Return values

OPEN_E_NONE	if system location get is successful.
OPEN_E_FAIL	if system location get has failed.
OPEN_E_PARAM	invalid 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_handle	Client handle from registration API
[in]	sys_location	System location
	maximum	buffer size OPEN_RFC1213_PARAM_SIZE - 1

Return values

OPEN_E_NONE	if system location set is successful.
OPEN_E_FAIL	if system location set has failed.
OPEN_E_PARAM	invalid 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_handle	Client handle from registration API
[out]	sys_name	System name
	minimum	buffer size OPEN_RFC1213_PARAM_SIZE

Return values

OPEN_E_NONE	if system name get is successful.
OPEN_E_FAIL	if system name get has failed.
OPEN_E_PARAM	invalid 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_handle	Client handle from registration API
[in]	sys_name	System name
	maximum	buffer size OPEN_RFC1213_PARAM_SIZE - 1

Return values

OPEN_E_NONE	if system name set is successful.
OPEN_E_FAIL	if system name set has failed.
OPEN_E_PARAM	invalid 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.