IP4Address class - Platform - BlueCat Gateway - 23.1

Gateway Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
23.1

class bluecat.ip4_address.IP4Address(api, api_entity)

Bases: bluecat.ip_object.IPAddress

Instantiate an IPv4 address.

Parameters Description
api

API instance used by the entity to communicate with BAM.

api_entity

The entity returned by the BAM API.

change_state_ip4_address(target_state, mac_address='')

Converts the state of an address from and between Reserved, DHCP Reserved, and Static, or DHCP Allocated to DHCP Reserved.

Parameters Description
target_state

The state the address should be changed into.

mac_address

Optional and only needed if the target requires it (e.g. MAKE_DHCP_RESERVED).

Returns: Updated IP4Address object.

staticmethod convert_ip_string_to_int(ip_string)

Calculate the integer value of an IPv4 address.

Parameters Description
ip_string

IPv4 address in string form.

Returns: Integer value of the IPv4 address.

get_reverse_name()

Get the reverse name for the address.