constants module - Platform - BlueCat Gateway - 22.4.1

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.4.1

Constants

class bluecat.constants.AccessRightTypes

Bases: bluecat.constants.ConstantsObject

Access Rights Values

AddAccess = 'ADD'

ChangeAccess = 'CHANGE'

FullAccess = 'FULL'

HideAccess = 'HIDE'

ViewAccess = 'VIEW'

class bluecat.constants.AccessRightValues

Bases: bluecat.constants.ConstantsObject

Access rights.

AddAccess = 'ADD'

ChangeAccess = 'CHANGE'

FullAccess = 'FULL'

HideAccess = 'HIDE'

ViewAccess = 'VIEW'

class bluecat.constants.BAMStats

Bases: bluecat.constants.ConstantsObject

BAM DB stats indicators.

DB_SIZE = 'DB_SIZE'

Total BAM DB size

ENTITY_COUNT = 'ENTITY_COUNT'

Total number of entities

GROUP_COUNT = 'GROUP_COUNT'

Total count of BAM user groups

IP4_ADDRESS_COUNT = 'IP4_ADDRESS_COUNT'

Total count of IPv4 addresses

IP4_BLOCK_COUNT = 'IP4_BLOCK_COUNT'

Total count of IPv4 blocks

IP4_NETWORK_COUNT = 'IP4_NETWORK_COUNT'

Total count of IPv4 networks

IP6_ADDRESS_COUNT = 'IP6_ADDRESS_COUNT'

Total count of IPv6 addresses

IP6_BLOCK_COUNT = 'IP6_BLOCK_COUNT'

Total count of IPv6 blocks

IP6_NETWORK_COUNT = 'IP6_NETWORK_COUNT'

Total count of IPv6 networks

LOCATION_COUNT = 'LOCATION_COUNT'

Total count of locations

MAC_ADDRESS_COUNT = 'MAC_ADDRESS_COUNT'

Total count of MAC addresses

RESOURCE_RECORD_COUNT = 'RESOURCE_RECORD_COUNT'

Total count of resource records

USER_COUNT = 'USER_COUNT'

Total count of BAM users

VIEW_COUNT = 'VIEW_COUNT'

Total count of views

ZONE_COUNT = 'ZONE_COUNT'

Total count of DNS zones

class bluecat.constants.ConfigurationAllowedFileExtension

Bases: bluecat.constants.ConstantsObject

Allowed extensions for uploaded files

autologin_module_path = ['py']

certificate_path = ['csr', 'cer', 'crt', 'pem']

custom_html_path = ['html']

gateway_crt = ['csr', 'cer', 'crt', 'pem']

gateway_key = ['key']

login_logo_custom_file = ['jpeg', 'gif', 'jpg', 'png', 'apng', 'svg', 'bmp']

logo_file = ['jpeg', 'gif', 'jpg', 'png', 'apng', 'svg', 'bmp']

tsig_key = ['key']

ui_customizations_file = ['json']

class bluecat.constants.ConfigurationFilePath

Bases: bluecat.constants.ConstantsObject

Configuration File Paths

MAIL_PASSWORD_PATH = 'customizations'

MONGO_PASSWORD_PATH = 'customizations'

additional_libraries_path = 'customizations/integrations'

autologin_module_path = 'customizations'

certificate_path = 'customizations/certificates'

logo_file = 'bluecat_portal/resources/images'

tsig_key = 'bluecat_portal/tsig-keys'

class bluecat.constants.ConfigurationFolderPath

Bases: bluecat.constants.ConstantsObject

Configuration Folder Paths

custom_html_path = 'customizations/html'

class bluecat.constants.ConstantsObject

Bases: object

Constants

correct_name(name)

This method verify that ‘name’ exist in constants.

Parameters Description
name  

Returns: True/False

get_names()

Return a list of names of the defined elements (constants).

Returns: A list of names of the defined ‘constants’.

Return type: list

get_values()

Return a list of values of the defined elements (constants).

Returns: A list of values of the defined ‘constants’.

Return type: list

is_valid_name(name)

Report whether the class has a defined element (constant) with the specified name.

Parameters Description
name(str) The name to be validated as defined in the referenced class.

Returns: Whether there is a defined ‘constant’ with the specified name.

Return type: bool

is_valid_value(value)

Report whether the class has a defined element (constant) with the specified value.

Parameters Description
value(any) The value to be validated that belongs to the referenced class.

Returns: Whether there is a defined ‘constant’ with the specified value.

Return type: bool

class bluecat.constants.DHCPDeploymentRoleType

Bases: bluecat.constants.ConstantsObject

DHCP Deployment Role Type

MASTER = 'MASTER'

NONE = 'NONE'

class bluecat.constants.DHCPLeaseStatus

Bases: bluecat.constants.ConstantsObject

DHCP Lease Status and their associated code

DHCP_ALLOCATED = 513

DHCP_FREE = 514

GATEWAY = 766

LEASED = 522

class bluecat.constants.DNSDeploymentRoleType

Bases: bluecat.constants.ConstantsObject

DNS Deployment Role Type

AD_MASTER = 'AD_MASTER'

FORWARDER = 'FORWARDER'

MASTER = 'MASTER'

MASTER_HIDDEN = 'MASTER_HIDDEN'

NONE = 'NONE'

RECURSION = 'RECURSION'

SLAVE = 'SLAVE'

SLAVE_STEALTH = 'SLAVE_STEALTH'

STUB = 'STUB'

class bluecat.constants.DNSSECKeyFormats

Bases: bluecat.constants.ConstantsObject

DNSSEC Key Formats

DNS_KEY = 'DNS_KEY'

DS_RECORD = 'DS_RECORD'

TRUST_ANCHOR = 'TRUST_ANCHOR'

class bluecat.constants.DeploymentServices

Bases: bluecat.constants.ConstantsObject

Deployment Services

DHCP = 'DHCP'

DHCPv6 = 'DHCPv6'

DNS = 'DNS'

TFTP = 'TFTP'

class bluecat.constants.EntityType

Bases: bluecat.constants.ConstantsObject

A base with members for referencing the identifiers for the types of entity objects.

Parent’s correct_name may be used for validating values.

Example:

from bluecat.constants import EntityType

foo(EntityType.ZONE, some_id)
Note: This is an abstract class. It is not intended to be instantiated.

ACL = 'ACL'

The value identifying entity type Access Control List (ACL).

ALIAS_RECORD = 'AliasRecord'

The value identifying entity type Alias Record.

CONFIGURATION = 'Configuration'

The value identifying entity type Configuration.

CUSTOM_OPTION_DEF = 'CustomOptionDef'

The value identifying entity type CustomOptionDef.

DENY_MAC_POOL = 'DenyMACPool'

The value identifying entity type DenyMACPool.

DEPLOYMENT_ROLE = 'DNSDeploymentRole'

The value identifying entity type DNSDeploymentRole.

DEPLOYMENT_SCHEDULER = 'DeploymentScheduler'

The value identifying entity type DeploymentScheduler.

DEVICE = 'Device'

The value identifying entity type Device.

DEVICE_SUBTYPE = 'DeviceSubtype'

The value identifying entity type DeviceSubtype.

DEVICE_TYPE = 'DeviceType'

The value identifying entity type DeviceType.

DHCP4_CLIENT_OPTION = 'DHCPV4ClientOption'

The value identifying entity type DHCPV4ClientOption.

DHCP4_RANGE = 'DHCP4Range'

The value identifying entity type DHCP4Range.

DHCP6_CLIENT_OPTION = 'DHCPV6ClientOption'

The value identifying entity type DHCPV6ClientOption.

DHCP6_RANGE = 'DHCP6Range'

The value identifying entity type DHCP6Range.

DHCP6_RAW_OPTION = 'DHCPV6_RAW'

The value identifying entity type DHCPV6RawOption.

DHCP6_SERVICE_OPTION = 'DHCPV6ServiceOption'

The value identifying entity type DHCPV6ServiceOption.

DHCP_DEPLOYMENT_ROLE = 'DHCPDeploymentRole'

The value identifying entity type DHCPDeploymentRole.

DHCP_MATCH_CLASS = 'DHCPMatchClass'

The value identifying entity type DHCPMatchClass.

DHCP_RAW_OPTION = 'DHCP_RAW'

The value identifying entity type DHCPRawOption.

DHCP_SERVICE_OPTION = 'DHCPServiceOption'

The value identifying entity type DHCPServiceOption.

DHCP_SUBCLASS = 'DHCPSubClass'

The value identifying entity type DHCPSubClass.

DNS = 'DNS'

The value identifying entity type DNS.

DNSSEC_SIGNING_POLICY = 'DNSSECSigningPolicy'

The value identifying entity type DNSSECSigningPolicy.

DNS_OPTION = 'DNSOption'

The value identifying entity type DNSOption.

DNS_RAW_OPTION = 'DNS_RAW'

The value identifying entity type DNSRawOption.

ENTITY = 'Entity'

The value identifying entity type Entity. This is a generic type.

ENUM_NUMBER = 'EnumNumber'

The value identifying entity type EnumNumber.

ENUM_ZONE = 'EnumZone'

The value identifying entity type EnumZone.

EXTERNAL_HOST_RECORD = 'ExternalHostRecord'

The value identifying entity type ExternalHostRecord.

GENERIC_RECORD = 'GenericRecord'

The value identifying entity type GenericRecord.

HINFO_RECORD = 'HINFORecord'

The value identifying entity type HINFORecord.

HOST_RECORD = 'HostRecord'

The value identifying entity type HostRecord.

INTERFACE_ID = 'InterfaceID'

The value identifying entity type InterfaceID.

INTERNAL_ROOT_ZONE = 'InternalRootZone'

The value identifying entity type InternalRootZone.

IP4_ADDRESS = 'IP4Address'

The value identifying entity type IP4Address.

IP4_BLOCK = 'IP4Block'

The value identifying entity type IP4Block.

IP4_IP_GROUP = 'IP4IPGroup'

The value identifying entity type IP4IPGroup.

IP4_NETWORK = 'IP4Network'

The value identifying entity type IP4Network.

IP4_NETWORK_TEMPLATE = 'IP4NetworkTemplate'

The value identifying entity type IP4NetworkTemplate.

IP4_RECONCILIATION_POLICY = 'IP4ReconciliationPolicy'

The value identifying entity type IP4ReconciliationPolicy.

IP6_ADDRESS = 'IP6Address'

The value identifying entity type IP6Address.

IP6_BLOCK = 'IP6Block'

The value identifying entity type IP6Block.

IP6_NETWORK = 'IP6Network'

The value identifying entity type IP6Network.

KERBEROS = 'Kerberos'

The value identifying entity type Kerberos.

KERBEROS_REALM = 'KerberosRealm'

The value identifying entity type KerberosRealm.

LDAP = 'LDAP'

The value identifying entity type LDAP.

LOCATION = 'Location'

The value identifying entity type Location.

MAC_ADDRESS = 'MACAddress'

The value identifying entity type MACAddress.

MAC_POOL = 'MACPool'

The value identifying entity type MACPool.

MX_RECORD = 'MXRecord'

The value identifying entity type MXRecord.

NAPTR_RECORD = 'NAPTRRecord'

The value identifying entity type NAPTRRecord.

NETWORK_INTERFACE = 'NetworkInterface'

The value identifying entity type NetworkInterface.

NETWORK_SERVER_INTERFACE = 'NetworkServerInterface'

The value identifying entity type NetworkServerInterface.

PUBLISHED_SERVER_INTERFACE = 'PublishedServerInterface'

The value identifying entity type PublishedServerInterface.

RADIUS = 'Radius'

The value identifying entity type Radius.

RECORD_WITH_LINK = 'RecordWithLink'

The value identifying entity type RecordWithLink.

RESPONSE_POLICY = 'ResponsePolicy'

The value identifying entity type ResponsePolicy.

RP_ZONE = 'RPZone'

The value identifying entity type RPZone.

SERVER = 'Server'

The value identifying entity type Server.

SRV_RECORD = 'SRVRecord'

The value identifying entity type SRVRecord.

START_OF_AUTHORITY = 'StartOfAuthority'

The value identifying entity type StartOfAuthority.

TAG = 'Tag'

The value identifying entity type Tag.

TAG_GROUP = 'TagGroup'

The value identifying entity type TagGroup.

TFTP_DEPLOYMENT_ROLE = 'TFTPDeploymentRole'

The value identifying entity type TFTPDeploymentRole.

TFTP_FILE = 'TFTPFile'

The value identifying entity type TFTPFile.

TFTP_FOLDER = 'TFTPFolder'

The value identifying entity type TFTPFolder.

TFTP_GROUP = 'TFTPGroup'

The value identifying entity type TFTPGroup.

TSIG_KEY = 'TSIGKey'

The value identifying entity type TSIGKey.

TXT_RECORD = 'TXTRecord'

The value identifying entity type TXTRecord.

USER = 'User'

The value identifying entity type User.

USER_GROUP = 'UserGroup'

The value identifying entity type UserGroup.

VENDOR_CLIENT_OPTION = 'VendorClientOption'

The value identifying entity type VendorClientOption.

VENDOR_PROFILE = 'VendorProfile'

The value identifying entity type VendorProfile.

VENDOR_PROFILE_DEF = 'VendorOptionDef'

The value identifying entity type VendorOptionDef.

VIEW = 'View'

The value identifying entity type View.

VIRTUAL_INTERFACE = 'VirtualInterface'

The value identifying entity type VirtualInterface.

ZONE = 'Zone'

The value identifying entity type Zone.

ZONE_TEMPLATE = 'ZoneTemplate'

The value identifying entity type ZoneTemplate.

class bluecat.constants.GetParentChainDiscriminatorsTypes

Bases: bluecat.constants.ConstantsObject

Constants for the valid types to use in the get_parent_chain Bulk API

ALIAS_RECORD = 'C'

HINFO_RECORD = 'HINFO'

HOST_RECORD = 'HOST'

MX_RECORD = 'MX'

NAPTR_RECORD = 'NAPTR'

SRV_RECORD = 'SRV'

TXT_RECORD = 'TXT'

ZONE = 'ZONE'

class bluecat.constants.IP4LeaseFields

Bases: bluecat.constants.ConstantsObject

IP4 Lease Fields objects

CIRCUIT_ID = 'circuit_id'

CLIENTHOST_NAME = 'clienthost_name'

CONF_ID = 'conf_id'

DHCP_CLIENT_IDENTIFIER = 'dhcp_client_identifier'

EXPIRE_TIME = 'expire_time'

ID = 'id'

IP_ADDRESS = 'ip_address'

IP_ADDRESS_ID = 'ip_address_id'

LAST_DHCP_STATUS = 'last_dhcp_status'

LAST_UPDATE_TIME = 'last_update_time'

LEASE_TIME = 'lease_time'

MAC_ADDRESS = 'mac_address'

PARAMETER_REQUEST_LIST = 'parameter_request_list'

REMOTE_ID = 'remote_id'

UPDATE_COUNT = 'update_count'

VENDOR_CLASS_IDENTIFIER = 'vendor_class_identifier'

class bluecat.constants.IP6AssignmentActionValues

Bases: bluecat.constants.ConstantsObject

IP6 Assignment Action Values

MAKE_DHCP_RESERVED = 'MAKE_DHCP_RESERVED'

MAKE_STATIC = 'MAKE_STATIC'

class bluecat.constants.IP6LeaseFields

Bases: bluecat.constants.ConstantsObject

IP6 Lease Fields objects

CIRCUIT_ID = 'circuit_id'

CLIENTHOST_NAME = 'clienthost_name'

CONF_ID = 'conf_id'

DUID_ID = 'duid_id'

EXPIRE_TIME = 'expire_time'

ID = 'id'

IP6_ADDRESS_HIGH = 'ip6_address_high'

IP6_ADDRESS_LOW = 'ip6_address_low'

IP_ADDRESS_ID = 'ip_address_id'

LAST_DHCP_STATUS = 'last_dhcp_status'

LAST_UPDATE_TIME = 'last_update_time'

LEASE_TIME = 'lease_time'

REMOTE_ID = 'remote_id'

UPDATE_COUNT = 'update_count'

class bluecat.constants.IPAddressStatesIP4

Bases: bluecat.constants.ConstantsObject

IPv4 Address States

DHCP_ALLOCATED = 'DHCP_ALLOCATED'

DHCP_FREE = 'DHCP_FREE'

DHCP_LEASED = 'DHCP_LEASED'

DHCP_RESERVED = 'DHCP_RESERVED'

GATEWAY = 'GATEWAY'

RESERVED = 'RESERVED'

STATIC = 'STATIC'

UNALLOCATED = 'UNALLOCATED'

class bluecat.constants.IPAddressStatesIP6

Bases: bluecat.constants.ConstantsObject

IPv6 Address States

DHCP_ALLOCATED = 'DHCP_ALLOCATED'

DHCP_FREE = 'DHCP_FREE'

DHCP_LEASED = 'DHCP_LEASED'

DHCP_RESERVED = 'DHCP_RESERVED'

GATEWAY = 'GATEWAY'

RESERVED = 'RESERVED'

STATIC = 'STATIC'

UNALLOCATED = 'UNALLOCATED'

class bluecat.constants.IPAssignmentActionValues

Bases: bluecat.constants.ConstantsObject

IP Assignment Action Values

MAKE_DHCP_RESERVED = 'MAKE_DHCP_RESERVED'

MAKE_RESERVED = 'MAKE_RESERVED'

MAKE_STATIC = 'MAKE_STATIC'

class bluecat.constants.IPv6AddAddressType

Bases: bluecat.constants.ConstantsObject

IP Address Creation types

INTERFACEID = 'InterfaceID'

IP6ADDRESS = 'IP6Address'

MACADDRESS = 'macAddress'

class bluecat.constants.RawDeploymentOptions

Bases: bluecat.constants.ConstantsObject

Raw Deployment Options

DEPLOYMENT_OPTION_DICT = {'DHCPV6_RAW': 'DHCPV6RawOption', 'DHCP_RAW': 'DHCPRawOption', 'DNS_RAW': 'DNSRawOption'}

DHCPRAWOPTION = 'DHCPRawOption'

DHCPV6RAWOPTION = 'DHCPV6RawOption'

DHCPV6_RAW = 'DHCPV6_RAW'

DHCP_RAW = 'DHCP_RAW'

DNSRAWOPTION = 'DNSRawOption'

DNS_RAW = 'DNS_RAW'

class bluecat.constants.RecordTypes

Bases: bluecat.constants.ConstantsObject

The generic record types

A6 = 'A6'

AAAA = 'AAAA'

AFSDB = 'AFSDB'

APL = 'APL'

CERT = 'CERT'

DNAME = 'DNAME'

DNSKEY = 'DNSKEY'

DS = 'DS'

ISDN = 'ISDN'

KEY = 'KEY'

KX = 'KX'

LOC = 'LOC'

MB = 'MB'

MG = 'MG'

MINFO = 'MINFO'

MR = 'MR'

NS = 'NS'

NSAP = 'NSAP'

PX = 'PX'

RP = 'RP'

RT = 'RT'

SINK = 'SINK'

SSHFP = 'SSHFP'

WKS = 'WKS'

X25 = 'X25'

class bluecat.constants.ResponsePolicy

Bases: bluecat.constants.ConstantsObject

Response Policy Types

BLACKHOLE = 'BLACKHOLE'

BLACKLIST = 'BLACKLIST'

WHITELIST = 'WHITELIST'

class bluecat.constants.ResponsePolicyItemSearchScope

Bases: bluecat.constants.ConstantsObject

Response Policy item search scopes

ALL = 'All'

FEED = 'Feed'

LOCAL = 'Local'

class bluecat.constants.SelectiveDeploymentStatus

Bases: bluecat.constants.ConstantsObject

Selective Deployment statuses

FAILED = 'FAILED'

FINISHED = 'FINISHED'

QUEUED = 'QUEUED'

STARTED = 'STARTED'

SUCCEEDED = 'SUCCEEDED'

TASK_NOT_FOUND = 'TASK_NOT_FOUND'

class bluecat.constants.TSIGKeyAlgorithm

Bases: bluecat.constants.ConstantsObject

Algorithm used in TSIG Key.

HMAC_MD5 = 'hmac-md5'

HMAC_SHA1 = 'hmac-sha1'

HMAC_SHA256 = 'hmac-sha256'

HMAC_SHA512 = 'hmac-sha512'

class bluecat.constants.TSIGKeyLength

Bases: bluecat.constants.ConstantsObject

Size of secret used in TSIG Key.

BITS_128 = 128

BITS_256 = 256

BITS_512 = 512

class bluecat.constants.TemplateValues

Bases: bluecat.constants.ConstantsObject

Template Values

IGNORE = 'IGNORE'

OVERWRITE = 'OVERWRITE'

UPDATE = 'UPDATE_IF_POSSIBLE'

UPDATE_IF_POSSIBLE = 'UPDATE_IF_POSSIBLE'

class bluecat.constants.UDFTypes

Bases: bluecat.constants.ConstantsObject

BAM User-defined field types.

BOOLEAN = 'BOOLEAN'

DATE = 'DATE'

EMAIL = 'EMAIL'

INTEGER = 'INTEGER'

LONG = 'LONG'

TEXT = 'TEXT'

URL = 'URL'

WORKFLOW = 'WORKFLOW'

class bluecat.constants.UDFValidatorProperties

Bases: bluecat.constants.ConstantsObject

BAM User-defined field validator properties.

MAX = 'max'

MAX_LENGTH = 'maxLength'

MIN = 'min'

MIN_LENGTH = 'minLength'

PATTERN = 'pattern'

class bluecat.constants.UserSessionState

Bases: bluecat.constants.ConstantsObject

Class providing class members for referencing State of User Session.

ACTIVE = 0

The session is still active.

LOGGED_OUT = 1

The session was logged out.

RESTARTED = 3

The session was restarted.

TIMED_OUT = 2

The session has timed out.