man pages section 3: Extended Library Functions, Volume 2

IMA_SetNetworkPortalIpAddress (3IMA)

Name

IMA_SetNetworkPortalIpAddress - Sets the IP address of a specified network portal

Synopsis

cc [ flag... ] file... -lima [ library... ]
#include <ima.h>

IMA_STATUS IMA_SetNetworkPortalIpAddress(
     /* in */     IMA_OID networkPortalOid,
     /* in */     const IMA_IP_ADDRESS *pNewIpAddress
);

Parameters

networkPortalOid

The object ID of the network portal whose IP address is being set.

pNewIpAddress

A pointer to an IMA_IP_ADDRESS data structure allocated and initialized by the caller. The structure contains the new IP address of the network portal specified by the networkPortalOid argument.

Description

The IMA_SetNetworkPortalIpAddress() API sets the IP address of a specified network portal.

Return Values

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before the setting of the IP address takes effect

IMA_ERROR_NOT_SUPPORTED

Returned if the specified network portal does not support the setting of its IP address

IMA_ERROR_INVALID_PARAMETER

Returned if the pNewIpAddress argument is NULL, or specifies a memory area from which data cannot be read

IMA_ERROR_INVALID_OBJECT_TYPE

Returned if the networkPortalOid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the networkPortalOid argument does not specify a network portal object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the networkPortalOid argument does not specify a network portal known to the system

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE Availability system/library/storage/snia-ima Interface Stability Volatile MT-Level Safe

See Also

libima(3LIB), attributes(7), IMA_GetNetworkPortalProperties(3IMA)