dhcpy.dhcpOption.DHCPOption

class documentation

class DHCPOption(object):

Constructor: DHCPOption(space, name, code, data, ...)

A class to represent a DHCP option

Method	`__dict__`	Return a dictionary representation of the option, for making JSON in the format KEA expects
Method	`__init__`	Initialize a DHCP option :param space: The vendor space of the option :param name: The name of the option :param code: The type code of the option :param data: The data of the option :param always_send: A boolean to determine if the option should always be sent...
Method	`always_send.setter`	Set a boolean to determine if the option should always be sent
Method	`always_send_string`	Return always_send as a string, all lowercase, for the JSON output
Method	`array.setter`	Value of the option is an array
Method	`array_string`	Return array as a string, all lowercase, for the JSON output
Method	`code.setter`	Set the code of the option
Method	`csv_format.setter`	Set the csv_format
Method	`data.setter`	Set the data of the option
Method	`encapsulate.setter`	Set the encapsulated name
Method	`fill_from_json`	:param json_str: :return:
Method	`name.setter`	Set the name of the option
Method	`never_send.setter`	Set a boolean to determine if the option should never be sent
Method	`record_types.setter`	Set the record_types
Method	`space.setter`	Set the vendor space of the option
Method	`type.setter`	Set the name of the option
Instance Variable	`always_send`	Return a boolean to determine if the option should always be sent
Instance Variable	`always_send_set`	Always send option was set
Instance Variable	`array`	Return a boolean to determine if the option is an array
Instance Variable	`array_set`	Array option was set
Instance Variable	`code`	Return the code of the option
Instance Variable	`csv_format`	Return the csv_format
Instance Variable	`csv_format_set`	CSV format option was set
Instance Variable	`data`	Return the data of the option
Instance Variable	`encapsulate`	Return the encapsulated name
Instance Variable	`encapsulate_set`	encapsulate option was set
Instance Variable	`name`	Return the name of the option
Instance Variable	`never_send`	Return a boolean to determine if the option should always be sent
Instance Variable	`never_send_set`	Never send option was set
Instance Variable	`option_usage`	Is the option defining or implementing an option
Instance Variable	`record_types`	Return the record_types
Instance Variable	`record_types_set`	record types option was set
Instance Variable	`space`	Return the vendor space of the option
Instance Variable	`type`	Return the data type
Instance Variable	`_always_send`	Undocumented
Instance Variable	`_array`	Undocumented
Instance Variable	`_array_set`	Undocumented
Instance Variable	`_code`	Undocumented
Instance Variable	`_csv_format`	Undocumented
Instance Variable	`_csv_format_set`	Undocumented
Instance Variable	`_data`	Undocumented
Instance Variable	`_encapsulate`	Undocumented
Instance Variable	`_encapsulate_set`	Undocumented
Instance Variable	`_name`	Undocumented
Instance Variable	`_never_send`	Undocumented
Instance Variable	`_record_types`	Undocumented
Instance Variable	`_record_types_set`	Undocumented
Instance Variable	`_space`	Undocumented
Instance Variable	`_type`	Undocumented

def __dict__(self): ¶

Return a dictionary representation of the option, for making JSON in the format KEA expects

def __init__(self, space='', name='', code=-1, data='', always_send=False, never_send=False, array=False, type=''): ¶

Initialize a DHCP option :param space: The vendor space of the option :param name: The name of the option :param code: The type code of the option :param data: The data of the option :param always_send: A boolean to determine if the option should always be sent

@always_send.setter
def always_send(self, always_send): ¶

Set a boolean to determine if the option should always be sent

def always_send_string(self): ¶

Return always_send as a string, all lowercase, for the JSON output

@array.setter
def array(self, value): ¶

Value of the option is an array

def array_string(self): ¶

Return array as a string, all lowercase, for the JSON output

@code.setter
def code(self, code): ¶

Set the code of the option

@csv_format.setter
def csv_format(self, value): ¶

Set the csv_format

@data.setter
def data(self, data): ¶

Set the data of the option

@encapsulate.setter
def encapsulate(self, value): ¶

Set the encapsulated name

def fill_from_json(self, json_str): ¶

:param json_str: :return:

@name.setter
def name(self, name): ¶

Set the name of the option

@never_send.setter
def never_send(self, never_send): ¶

Set a boolean to determine if the option should never be sent

@record_types.setter
def record_types(self, value): ¶

Set the record_types

@space.setter
def space(self, space): ¶

Set the vendor space of the option

@type.setter
def type(self, type): ¶

Set the name of the option

@property
always_send = ¶

Return a boolean to determine if the option should always be sent

always_send_set: bool = ¶

Always send option was set

@property
array = ¶

Return a boolean to determine if the option is an array

array_set: bool = ¶

Array option was set

@property
code = ¶

Return the code of the option

@property
csv_format = ¶

Return the csv_format

csv_format_set: bool = ¶

CSV format option was set

@property
data = ¶

Return the data of the option

@property
encapsulate = ¶

Return the encapsulated name

encapsulate_set: str = ¶

encapsulate option was set

@property
name = ¶

Return the name of the option

@property
never_send = ¶

Return a boolean to determine if the option should always be sent

never_send_set: bool = ¶

Never send option was set

option_usage = ¶

Is the option defining or implementing an option

@property
record_types = ¶

Return the record_types

record_types_set: str = ¶

record types option was set

@property
space = ¶

Return the vendor space of the option

@property
type = ¶

Return the data type

_always_send = ¶

Undocumented

_array = ¶

Undocumented

_array_set: bool = ¶

Undocumented

_code = ¶

Undocumented

_csv_format = ¶

Undocumented

_csv_format_set: bool = ¶

Undocumented

_data = ¶

Undocumented

_encapsulate = ¶

Undocumented

_encapsulate_set: bool = ¶

Undocumented

_name = ¶

Undocumented

_never_send = ¶

Undocumented

_record_types = ¶

Undocumented

_record_types_set: bool = ¶

Undocumented

_space = ¶

Undocumented

_type = ¶

Undocumented