Networking, Lens API, subnet
Description
A subnet is an instance of an IP network, defined by name and IP range.
Parameter prefix: net
Relationships
vlans
Related type: vlan
Description: The set of vlan objects for which this subnet instance provides IP routing (typically only one at any point in time)
Dressing parameter: net_vlans
Cardinality: zero to many (list)
Relationship Attribute: None because it is a Many-to-Many. The related IDs are only in the vlans relationship attribute list.
Availability: This topic/item has not yet been finalized.
observed_arps
Related type: ip_mac
Description: The set of ip_mac association objects that were observed for IPs in this subnet.
Dressing parameter: net_observed_arps
Cardinality: zero to many (list)
Relationship Attribute: None because it is a Many-to-Many. The related IDs are only in the observed_arps relationship attribute list.
Availability: This topic/item has not yet been finalized.
Attributes
Identity attribute
| Attribute | Data type | Description | Query parameter datatype |
|---|---|---|---|
| subnet_id | Instance identifier | Unique subnet record identifier | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter datatype |
|---|---|---|---|
| subnet_name | Text | The name of the subnet | String |
| subnet | Text | The network_address/cidr_mask notation that defines the subnet by starting IP and size. | String |
| network_address | IP | The network address of the subnet, as a dotted-decimal string | IP |
| cidr_mask | Integer | The subnet mask in CIDR notation | Number |
| current | Boolean | True when this subnet configuration is in operation at present time | Boolean (1 or 0) |
| start_date | Timestamp | Time when this configuration became known to Lens | Date |
| end_date | Timestamp | Time when configuration is known to have ceased, or 1/1/2037 for current configurations | Date |