address DataStream¶
address
DataStream contains summarized IPAM Address state
Fields¶
Name | Type | Description |
---|---|---|
id | String | Address id |
change_id | String | Record's Change Id |
name | String | Address name |
address | String | Address (i.e. 192.168.0.1 ) |
fqdn | String | Fully-Qualified Domain Name for address |
afi | String | Address family: |
• ipv4 | ||
• ipv6 | ||
description | String | Address textual description |
mac | String | Related MAC address |
subinterface | String | Related subinterface name |
tags | Array of String | VRF tags |
state | Object | VRF workflow state |
id | String | State id |
name | String | State name |
workflow | Object | VRF workflow |
id | String | Workflow id |
name | String | Workflow name |
allocated_till | Datetime | Workflow state deadline |
profile | Object | Address Profile |
id | String | Address Profile id |
name | String | Address Profile name |
vrf | Object | Prefix VRF |
id | String | VRF id |
name | String | VRF name |
project | Object | Address Project |
id | String | Project id |
name | String | Project name |
source | String | VRF Learning source: |
• M - Manual | ||
• i - Interface | ||
• m - Management | ||
• d - DHCP | ||
• n - Neighbor |
Access¶
API Key with datastream:address
permission is required.