Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_SetIpConfigMethod (3IMA)

Name

IMA_SetIpConfigMethod - Sets the IP configuration method for a specified physical network port

Synopsis

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

IMA_STATUS IMA_SetIpConfigMethod(
      /* in */     IMA_OID oid,
      /* in */     IMA_BOOL enableDhcpIpConfiguration
);

Parameters

oid

The object ID of the physical network port (PNP) whose IP configuration method is to be set.

enableDhcpI[Configuration

A boolean indicating whether DHCP configuration of IP is being enabled.

  • If this parameter has the value, IMA_TRUE, then DHCP configuration of IP is enabled.

  • If this parameter has the value, IMA_FALSE, then DHCP configuration of IP is disabled, thereby enabling static configuration of IP.

Description

The IMA_SetIpConfigMethod() API sets the IP configuration method for a specified PNP.

Return Values

IMA_STATUS_REBOOT_NECESSARY

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

IMA_ERROR_INVALID_PARAMETER

Returned if the enableDhcpIpConfiguration argument does not contain the value, IMA_TRUE, or the value, IMA_FALSE

IMA_ERROR_NOT_SUPPORTED

Returned if setting the IP configuration method is not supported by the specified PHBA

IMA_ERROR_INVALID_OBJECT_TYPE

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

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the oid argument does not specify a PNP object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a PNP 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_GetIpProperties(3IMA), IMA_SetDefaultGateway(3IMA), IMA_SetDnsServerAddress(3IMA), IMA_SetSubnetMask(3IMA)