Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › CLI IP Configuration Methods

CLI IP Configuration Methods

GetEndIPAddress Method—Retrieves the Ending IP Address

The GetEndIPAddress method retrieves the ending IP address for an IP address range.

Syntax

The GetEndIPAddress method has the following format:

Netegrity::PolicyMgtIPConfig‑>GetEndIPAddress( )

Parameters

The GetEndIPAddress method accepts no parameters.

Return Value

The GetEndIPAddress method returns one of the following values:

• The ending IP address in a range of accepted IP addresses.
• undef if the call is unsuccessful

Remarks

See the method PolicyMgtAffiliate‑>CreateIPConfigRange for more information.

GetHostName Method—Retrieves the Host Name Associated with a Host Name IP Address Restriction

The GetHostName method retrieves the host name associated with a host name IP address restriction.

Syntax

The GetHostName method has the following format:

Netegrity::PolicyMgtIPConfig‑>GetHostName()

Parameters

The GetHostName method accepts no parameters.

Return Value

The GetHostName method returns one of the following values:

• The host name of the machine where requests originate
• undef if the call is unsuccessful

Remarks

See the method PolicyMgtAffiliate‑>CreateIPConfigHostName for more information.

GetIPAddress Method— Retrieves an IP address for an IP address restriction

The GetIPAddress method retrieves an IP address for an IP address restriction, as follows:

• For IPCFG_TYPE_SINGLEHOST IP addresses, retrieves the IP address of the machine where requests must originate for the policy to fire. See the PolicyMgtAffiliate‑>CreateIPConfigSingleHost method description for more information.
• For IPCFG_TYPE_RANGE IP address restrictions, retrieves the starting IP address in the range of accepted IP addresses. See the description of the PolicyMgtAffiliate‑>CreateIPConfigRange method for more information.

To determine the type of IP address restriction, call the GetType method.

Syntax

The GetIPAddress method has the following format:

Netegrity::PolicyMgtIPConfig‑>GetIPAddress()

Parameters

The GetIPAddress method accepts no parameters.

Return Value

The GetIPAddress method returns one of the following values:

• The IP address where requests must originate, or the starting address in a range of accepted addresses.
• undef if the call is unsuccessful

GetSubnetMask Method—Retrieves the Subnet Mask for a Subnet Address

The GetSubnetMask method retrieves the subnet mask for a subnet address derived from a specified subnet mask and IP address.

Syntax

The GetSubnetMask method has the following format:

Netegrity::PolicyMgtIPConfig‑>GetSubnetMask( )

Parameters

The GetSubnetMask method accepts no parameters.

Return Value

The GetSubnetMask method returns one of the following values:

• The subnet mask
• undef if the call is unsuccessful

Remarks

See the description of the PolicyMgtPolicy‑>CreateIPConfigSubnetMask method for more information.

GetType Method—Retrieves the Type of the IP Address Restriction

The GetType method retrieves the type of the IP address restriction. An IP address restriction specifies where a request must originate before it can be honored.

Syntax

The GetType method has the following format:

Netegrity::PolicyMgtIPConfig‑>GetType()

Parameters

The GetType method accepts no parameters.

Return Value

The GetType method returns one of the following values:

• IPCFG_TYPE_SINGLEHOST (Value=1). The request must come from the specified IP address. This type of IP address restriction is created with the PolicyMgtAffiliate‑>CreateIPConfigSingleHost method.
• IPCFG_TYPE_HOSTNAME (Value=2). The request must come from a machine with a specific host name. This type of IP address restriction is created with the PolicyMgtAffiliate‑>CreateIPConfigHostName method.
• IPCFG_TYPE_SUBNETMASK (Value=3). The request must come from the specified subnet mask. This type of IP address restriction is created with the PolicyMgtPolicy‑>CreateIPConfigSubnetMask method.
• IPCFG_TYPE_RANGE (Value=4). The request must come from a range of IP addresses. This type of IP address restriction is created with the PolicyMgtAffiliate‑>CreateIPConfigRange method.
• undef if the call is unsuccessful