Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_SetIsnsDiscovery (3IMA)

Name

IMA_SetIsnsDiscovery - Enables or disables iSNS target discovery for a PHBA, LHBA, or network portal

Synopsis

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

IMA_STATUS IMA_SetIsnsDiscovery(
     /* in */    IMA_OID oid,
     /* in */    IMA_BOOL enableIsnsDiscovery,
     /* in */    IMA_ISNS_DISCOVERY_METHOD discoveryMethod,
     /* in */    const IMA_HOST_ID *iSnsHost
);

Parameters

oid

The object ID of the physical host bus adapter (PHBA), logical host bus adapter (LHBA), or network portal whose iSNS target discovery properties are being set.

enableIsnsDiscovery
  • Set to the value, IMA_TRUE if the PHBA, LHBA, or network portal will discover targets using the iSNS protocol.

  • Set to the value, IMA_FALSE if the PHBA,LHBA, or network portal will not discover targets using the iSNS protocol.

discoveryMethod
  • If the enableIsnsDiscovery argument has the value the value, IMA_TRUE, then this parameter specifies the method that is used to discover the iSNS server.

  • If this parameter has the value, IMA_ISNS_DISCOVERY_METHOD_STATIC, then the iSNS server will be discovered statically. In this case the iSnsHost parameter contains the name or address of the iSNS server, and the iSNS server at that location is used.

  • If this parameter has the value, IMA_ISNS_DISCOVERY_METHOD_DHCP, then the iSNS server will be discovered using the DHCP protocol.

  • If this parameter has the value, IMA_ISNS_DISCOVERY_METHOD_SLP, then the iSNS server will be discovered using the SLP protocol.

iSnsHost
  • If the enableIsnsDiscovery argument has the value, IMA_TRUE, and the discoveryMethod argument has the value, IMA_ISNS_DISCOVERY_METHOD_STATIC, then this is a pointer to the host name of the iSNS server to be used.

  • If the enableIsnsDiscovery argument has the value, IMA_FALSE, or the enableIsnsDiscovery argument has the value, IMA_TRUE, but the discoveryMethod argument does not have the value, IMA_ISNS_DISCOVERY_METHOD_STATIC, then this parameter is NULL.

Description

The IMA_SetIsnsDiscovery() API enables or disables the iSNS target discovery property for a PHBA, LHBA, or network portal.

Return Values

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before this call will take effect.

IMA_ERROR_NOT_SUPPORTED

Returned if the enabling or disabling of the iSNS target discovery property is not supported by the specified PHBA, LHBA, or network portal.

IMA_ERROR_INVALID_PARAMETER
  • Returned if the enableIsnsDiscovery argument has a value other than the value, IMA_TRUE, or the value, IMA_FALSE.

  • Returned if the discoveryMethod argument has a value other than

    • IMA_ISNS_DISCOVERY_METHOD_STATIC

    • IMA_ISNS_DISCOVERY_METHOD_DHCP

    • IMA_ISNS_DISCOVERY_METHOD_SLP

  • Returned if enabledIsnsDiscovery has the value IMA_TRUE and domainName is NULL or specifies a memory area from which data cannot be read.

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 PHBA, LHBA, or network portal object.

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a PHBA, LHBA, or network portal that is currently known to the system.

IMA_ERROR_LAST_PRIMARY_DISCOVERY_METHOD

Returned if the enableIsnsDiscovery argument is set to the value, IMA_FALSE, and iSNS target discovery is the last primary discovery method for the PHBA or LHBA. This means that both the SLP target discovery and static target discovery properties are either disabled or not supported.

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_GetDiscoveryProperties(3IMA), IMA_SetSlpDiscovery(3IMA), IMA_SetStaticDiscovery(3IMA), IMA_SetSendTargetsDiscovery(3IMA)