Lease

The Lease Object defines the ephemeral mapping of a token, as defined by the reservation's or subnet's strategy, and an IP address assigned by the reservation or pulled form the subnet's pool. The lease contains the Strategy used for the token and the expiration time. The contents of the lease are immutable with the exception of the expiration time.

Leases track what IP addresses the system has handed out to what strategy/token pairs.

Field	Definition
Addr	Addr is the IP address that the lease handed out. required: true swagger:strfmt ipv4
Duration	Duration is the time in seconds for which a lease can be valid. ExpireTime is calculated from Duration.
ExpireTime	ExpireTime is the time at which the lease expires and is no longer valid The DHCP renewal time will be half this, and the DHCP rebind time will be three quarters of this. required: true swagger:strfmt date-time
MachineUuid	MachineUuid is set when the lease is created on a machine object only. required: false
Meta	Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata
NextServer	NextServer is the IP address that we should have the machine talk to next. In most cases, this will be our address. required: false swagger:strfmt ipv4
Options	Options are the DHCP options that the Lease is running with.
Options/Code	Code is a DHCP Option Code. required: true
Options/Value	Value is a text/template that will be expanded and then converted into the proper format for the option code required: true
ProvidedOptions	ProvidedOptions are the DHCP options the last Discover or Offer packet for this lease provided to us.
ProvidedOptions/Code	Code is a DHCP Option Code. required: true
ProvidedOptions/Value	Value is a text/template that will be expanded and then converted into the proper format for the option code required: true
SkipBoot	SkipBoot indicates that the DHCP system is allowed to offer boot options for whatever boot protocol the machine wants to use. read only: true
State	State is the current state of the lease. This field is for informational purposes only. read only: true required: true
Strategy	Strategy is the leasing strategy that will be used determine what to use from the DHCP packet to handle lease management. required: true
Token	Token is the unique token for this lease based on the Strategy this lease used. required: true
Via	Via is the IP address used to select which subnet the lease belongs to. It is either an address present on a local interface that dr-provision is listening on, or the GIADDR field of the DHCP request. required: false swagger:strfmt ipv4