NCP::Domain module overview

The NCP::Domain module provides an interface to perform operations on NCIM Network Manager domains.

NCP::Domain constructor

Before accessing the methods that the NCP::Domain module provides, you must call the NCP::Domain constructor to create a new NCP::Domain object. The NCP::Domain constructor requires the domain name and options for the database connection. The newly created NCP::Domain object encapsulates the attributes associated with the specified domain and database connection.

NCIM domain operation methods

The NCP::Domain module provides methods that client/server applications use to perform a variety of operations on a specified NCIM domains. Some of these operations involve the domainMgr table in the NCIM topology database that resides in the specified domain.

The following table identifies and briefly describes the database operation methods that the NCP::Domain module provides:

NCIM domain database method Description

clone

Creates a new domain that is a copy of an existing domain.

create

Creates an entry in the domainMgr table for this domain if one does not already exist.

drop

Removes all references to the specified domain from the domainMgr table.

id

Retrieves the domainMgrId from the domainMgr table in the NCIM topology database that resides in the specified domain.

name

Returns the domain name for the current domain.

setLogHandle

Passes in a log handle associated with an opened file used for logging messages.

setLogLevel

Sets the log level for error and message reporting.

See NCP::Domain Reference for the reference (man) pages associated with these methods.