CloudCommunityEnterprise
Protocol Documentation
Table of Contents
diode/v1/ingester.proto
ASN
| Field | Type | Label | Description |
|---|---|---|---|
| asn | int64 | ||
| rir | RIR | optional | |
| tenant | Tenant | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ASN.CustomFieldsEntry | repeated |
ASN.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ASNRange
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| rir | RIR | ||
| start | int64 | ||
| end | int64 | ||
| tenant | Tenant | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ASNRange.CustomFieldsEntry | repeated |
ASNRange.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Aggregate
| Field | Type | Label | Description |
|---|---|---|---|
| prefix | string | ||
| rir | RIR | ||
| tenant | Tenant | optional | |
| date_added | google.protobuf.Timestamp | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Aggregate.CustomFieldsEntry | repeated |
Aggregate.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Cable
| Field | Type | Label | Description |
|---|---|---|---|
| type | string | optional | |
| a_terminations | GenericObject | repeated | |
| b_terminations | GenericObject | repeated | |
| status | string | optional | |
| tenant | Tenant | optional | |
| label | string | optional | |
| color | string | optional | |
| length | double | optional | |
| length_unit | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Cable.CustomFieldsEntry | repeated |
Cable.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
CablePath
| Field | Type | Label | Description |
|---|---|---|---|
| is_active | bool | optional | |
| is_complete | bool | optional | |
| is_split | bool | optional |
CableTermination
| Field | Type | Label | Description |
|---|---|---|---|
| cable | Cable | ||
| cable_end | string | ||
| termination_circuit_termination | CircuitTermination | ||
| termination_console_port | ConsolePort | ||
| termination_console_server_port | ConsoleServerPort | ||
| termination_front_port | FrontPort | ||
| termination_interface | Interface | ||
| termination_power_feed | PowerFeed | ||
| termination_power_outlet | PowerOutlet | ||
| termination_power_port | PowerPort | ||
| termination_rear_port | RearPort |
Circuit
| Field | Type | Label | Description |
|---|---|---|---|
| cid | string | ||
| provider | Provider | ||
| provider_account | ProviderAccount | optional | |
| type | CircuitType | ||
| status | string | optional | |
| tenant | Tenant | optional | |
| install_date | google.protobuf.Timestamp | optional | |
| termination_date | google.protobuf.Timestamp | optional | |
| commit_rate | int64 | optional | |
| description | string | optional | |
| distance | double | optional | |
| distance_unit | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| assignments | CircuitGroupAssignment | repeated | |
| custom_fields | Circuit.CustomFieldsEntry | repeated |
Circuit.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
CircuitGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| tenant | Tenant | optional | |
| tags | Tag | repeated | |
| custom_fields | CircuitGroup.CustomFieldsEntry | repeated |
CircuitGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
CircuitGroupAssignment
| Field | Type | Label | Description |
|---|---|---|---|
| group | CircuitGroup | ||
| member_circuit | Circuit | ||
| member_virtual_circuit | VirtualCircuit | ||
| priority | string | optional | |
| tags | Tag | repeated |
CircuitTermination
| Field | Type | Label | Description |
|---|---|---|---|
| circuit | Circuit | ||
| term_side | string | ||
| termination_location | Location | ||
| termination_provider_network | ProviderNetwork | ||
| termination_region | Region | ||
| termination_site | Site | ||
| termination_site_group | SiteGroup | ||
| port_speed | int64 | optional | |
| upstream_speed | int64 | optional | |
| xconnect_id | string | optional | |
| pp_info | string | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | CircuitTermination.CustomFieldsEntry | repeated |
CircuitTermination.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
CircuitType
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| color | string | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | CircuitType.CustomFieldsEntry | repeated |
CircuitType.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Cluster
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| type | ClusterType | ||
| group | ClusterGroup | optional | |
| status | string | optional | |
| tenant | Tenant | optional | |
| scope_location | Location | ||
| scope_region | Region | ||
| scope_site | Site | ||
| scope_site_group | SiteGroup | ||
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Cluster.CustomFieldsEntry | repeated |
Cluster.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ClusterGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ClusterGroup.CustomFieldsEntry | repeated |
ClusterGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ClusterType
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ClusterType.CustomFieldsEntry | repeated |
ClusterType.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ConsolePort
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | optional | |
| speed | int64 | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | ConsolePort.CustomFieldsEntry | repeated |
ConsolePort.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ConsoleServerPort
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | optional | |
| speed | int64 | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | ConsoleServerPort.CustomFieldsEntry | repeated |
ConsoleServerPort.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Contact
| Field | Type | Label | Description |
|---|---|---|---|
| group | ContactGroup | optional | Deprecated. |
| name | string | ||
| title | string | optional | |
| phone | string | optional | |
string | optional | ||
| address | string | optional | |
| link | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Contact.CustomFieldsEntry | repeated | |
| groups | ContactGroup | repeated |
Contact.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ContactAssignment
| Field | Type | Label | Description |
|---|---|---|---|
| object_asn | ASN | ||
| object_asn_range | ASNRange | ||
| object_aggregate | Aggregate | ||
| object_cable | Cable | ||
| object_cable_path | CablePath | ||
| object_cable_termination | CableTermination | ||
| object_circuit | Circuit | ||
| object_circuit_group | CircuitGroup | ||
| object_circuit_group_assignment | CircuitGroupAssignment | ||
| object_circuit_termination | CircuitTermination | ||
| object_circuit_type | CircuitType | ||
| object_cluster | Cluster | ||
| object_cluster_group | ClusterGroup | ||
| object_cluster_type | ClusterType | ||
| object_console_port | ConsolePort | ||
| object_console_server_port | ConsoleServerPort | ||
| object_contact | Contact | ||
| object_contact_assignment | ContactAssignment | ||
| object_contact_group | ContactGroup | ||
| object_contact_role | ContactRole | ||
| object_device | Device | ||
| object_device_bay | DeviceBay | ||
| object_device_role | DeviceRole | ||
| object_device_type | DeviceType | ||
| object_fhrp_group | FHRPGroup | ||
| object_fhrp_group_assignment | FHRPGroupAssignment | ||
| object_front_port | FrontPort | ||
| object_ike_policy | IKEPolicy | ||
| object_ike_proposal | IKEProposal | ||
| object_ip_address | IPAddress | ||
| object_ip_range | IPRange | ||
| object_ip_sec_policy | IPSecPolicy | ||
| object_ip_sec_profile | IPSecProfile | ||
| object_ip_sec_proposal | IPSecProposal | ||
| object_interface | Interface | ||
| object_inventory_item | InventoryItem | ||
| object_inventory_item_role | InventoryItemRole | ||
| object_l2vpn | L2VPN | ||
| object_l2vpn_termination | L2VPNTermination | ||
| object_location | Location | ||
| object_mac_address | MACAddress | ||
| object_manufacturer | Manufacturer | ||
| object_module | Module | ||
| object_module_bay | ModuleBay | ||
| object_module_type | ModuleType | ||
| object_platform | Platform | ||
| object_power_feed | PowerFeed | ||
| object_power_outlet | PowerOutlet | ||
| object_power_panel | PowerPanel | ||
| object_power_port | PowerPort | ||
| object_prefix | Prefix | ||
| object_provider | Provider | ||
| object_provider_account | ProviderAccount | ||
| object_provider_network | ProviderNetwork | ||
| object_rir | RIR | ||
| object_rack | Rack | ||
| object_rack_reservation | RackReservation | ||
| object_rack_role | RackRole | ||
| object_rack_type | RackType | ||
| object_rear_port | RearPort | ||
| object_region | Region | ||
| object_role | Role | ||
| object_route_target | RouteTarget | ||
| object_service | Service | ||
| object_site | Site | ||
| object_site_group | SiteGroup | ||
| object_tag | Tag | ||
| object_tenant | Tenant | ||
| object_tenant_group | TenantGroup | ||
| object_tunnel | Tunnel | ||
| object_tunnel_group | TunnelGroup | ||
| object_tunnel_termination | TunnelTermination | ||
| object_vlan | VLAN | ||
| object_vlan_group | VLANGroup | ||
| object_vlan_translation_policy | VLANTranslationPolicy | ||
| object_vlan_translation_rule | VLANTranslationRule | ||
| object_vm_interface | VMInterface | ||
| object_vrf | VRF | ||
| object_virtual_chassis | VirtualChassis | ||
| object_virtual_circuit | VirtualCircuit | ||
| object_virtual_circuit_termination | VirtualCircuitTermination | ||
| object_virtual_circuit_type | VirtualCircuitType | ||
| object_virtual_device_context | VirtualDeviceContext | ||
| object_virtual_disk | VirtualDisk | ||
| object_virtual_machine | VirtualMachine | ||
| object_wireless_lan | WirelessLAN | ||
| object_wireless_lan_group | WirelessLANGroup | ||
| object_wireless_link | WirelessLink | ||
| object_custom_field | CustomField | ||
| object_custom_field_choice_set | CustomFieldChoiceSet | ||
| object_journal_entry | JournalEntry | ||
| object_module_type_profile | ModuleTypeProfile | ||
| object_custom_link | CustomLink | ||
| contact | Contact | ||
| role | ContactRole | optional | |
| priority | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ContactAssignment.CustomFieldsEntry | repeated |
ContactAssignment.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ContactGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| parent | ContactGroup | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ContactGroup.CustomFieldsEntry | repeated | |
| comments | string | optional |
ContactGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ContactRole
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ContactRole.CustomFieldsEntry | repeated |
ContactRole.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
CustomField
| Field | Type | Label | Description |
|---|---|---|---|
| type | string | ||
| related_object_type | string | optional | |
| name | string | ||
| label | string | optional | |
| group_name | string | optional | |
| description | string | optional | |
| required | bool | optional | |
| unique | bool | optional | |
| search_weight | int64 | optional | |
| filter_logic | string | optional | |
| ui_visible | string | optional | |
| ui_editable | string | optional | |
| is_cloneable | bool | optional | |
| default | string | optional | |
| related_object_filter | string | optional | |
| weight | int64 | optional | |
| validation_minimum | double | optional | |
| validation_maximum | double | optional | |
| validation_regex | string | optional | |
| choice_set | CustomFieldChoiceSet | optional | |
| comments | string | optional | |
| object_types | string | repeated |
CustomFieldChoiceSet
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| base_choices | string | optional | |
| order_alphabetically | bool | optional | |
| extra_choices | string | repeated |
CustomFieldObjectReference
| Field | Type | Label | Description |
|---|---|---|---|
| asn | ASN | ||
| asn_range | ASNRange | ||
| aggregate | Aggregate | ||
| cable | Cable | ||
| cable_path | CablePath | ||
| cable_termination | CableTermination | ||
| circuit | Circuit | ||
| circuit_group | CircuitGroup | ||
| circuit_group_assignment | CircuitGroupAssignment | ||
| circuit_termination | CircuitTermination | ||
| circuit_type | CircuitType | ||
| cluster | Cluster | ||
| cluster_group | ClusterGroup | ||
| cluster_type | ClusterType | ||
| console_port | ConsolePort | ||
| console_server_port | ConsoleServerPort | ||
| contact | Contact | ||
| contact_assignment | ContactAssignment | ||
| contact_group | ContactGroup | ||
| contact_role | ContactRole | ||
| device | Device | ||
| device_bay | DeviceBay | ||
| device_role | DeviceRole | ||
| device_type | DeviceType | ||
| fhrp_group | FHRPGroup | ||
| fhrp_group_assignment | FHRPGroupAssignment | ||
| front_port | FrontPort | ||
| ike_policy | IKEPolicy | ||
| ike_proposal | IKEProposal | ||
| ip_address | IPAddress | ||
| ip_range | IPRange | ||
| ip_sec_policy | IPSecPolicy | ||
| ip_sec_profile | IPSecProfile | ||
| ip_sec_proposal | IPSecProposal | ||
| interface | Interface | ||
| inventory_item | InventoryItem | ||
| inventory_item_role | InventoryItemRole | ||
| l2vpn | L2VPN | ||
| l2vpn_termination | L2VPNTermination | ||
| location | Location | ||
| mac_address | MACAddress | ||
| manufacturer | Manufacturer | ||
| module | Module | ||
| module_bay | ModuleBay | ||
| module_type | ModuleType | ||
| platform | Platform | ||
| power_feed | PowerFeed | ||
| power_outlet | PowerOutlet | ||
| power_panel | PowerPanel | ||
| power_port | PowerPort | ||
| prefix | Prefix | ||
| provider | Provider | ||
| provider_account | ProviderAccount | ||
| provider_network | ProviderNetwork | ||
| rir | RIR | ||
| rack | Rack | ||
| rack_reservation | RackReservation | ||
| rack_role | RackRole | ||
| rack_type | RackType | ||
| rear_port | RearPort | ||
| region | Region | ||
| role | Role | ||
| route_target | RouteTarget | ||
| service | Service | ||
| site | Site | ||
| site_group | SiteGroup | ||
| tag | Tag | ||
| tenant | Tenant | ||
| tenant_group | TenantGroup | ||
| tunnel | Tunnel | ||
| tunnel_group | TunnelGroup | ||
| tunnel_termination | TunnelTermination | ||
| vlan | VLAN | ||
| vlan_group | VLANGroup | ||
| vlan_translation_policy | VLANTranslationPolicy | ||
| vlan_translation_rule | VLANTranslationRule | ||
| vm_interface | VMInterface | ||
| vrf | VRF | ||
| virtual_chassis | VirtualChassis | ||
| virtual_circuit | VirtualCircuit | ||
| virtual_circuit_termination | VirtualCircuitTermination | ||
| virtual_circuit_type | VirtualCircuitType | ||
| virtual_device_context | VirtualDeviceContext | ||
| virtual_disk | VirtualDisk | ||
| virtual_machine | VirtualMachine | ||
| wireless_lan | WirelessLAN | ||
| wireless_lan_group | WirelessLANGroup | ||
| wireless_link | WirelessLink | ||
| custom_field | CustomField | ||
| custom_field_choice_set | CustomFieldChoiceSet | ||
| journal_entry | JournalEntry | ||
| module_type_profile | ModuleTypeProfile | ||
| custom_link | CustomLink |
CustomFieldValue
| Field | Type | Label | Description |
|---|---|---|---|
| multiple_selection | string | repeated | |
| multiple_objects | CustomFieldObjectReference | repeated | |
| text | string | ||
| long_text | string | ||
| integer | int64 | ||
| decimal | double | ||
| boolean | bool | ||
| date | google.protobuf.Timestamp | ||
| datetime | google.protobuf.Timestamp | ||
| url | string | ||
| json | string | ||
| selection | string | ||
| object | CustomFieldObjectReference |
CustomLink
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| enabled | bool | optional | |
| link_text | string | ||
| link_url | string | ||
| weight | int64 | optional | |
| group_name | string | optional | |
| button_class | string | optional | |
| new_window | bool | optional | |
| object_types | string | repeated |
Device
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | optional | |
| device_type | DeviceType | ||
| role | DeviceRole | ||
| tenant | Tenant | optional | |
| platform | Platform | optional | |
| serial | string | optional | |
| asset_tag | string | optional | |
| site | Site | ||
| location | Location | optional | |
| rack | Rack | optional | |
| position | double | optional | |
| face | string | optional | |
| latitude | double | optional | |
| longitude | double | optional | |
| status | string | optional | |
| airflow | string | optional | |
| primary_ip4 | IPAddress | optional | |
| primary_ip6 | IPAddress | optional | |
| oob_ip | IPAddress | optional | |
| cluster | Cluster | optional | |
| virtual_chassis | VirtualChassis | optional | |
| vc_position | int64 | optional | |
| vc_priority | int64 | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Device.CustomFieldsEntry | repeated |
Device.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
DeviceBay
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| name | string | ||
| label | string | optional | |
| description | string | optional | |
| installed_device | Device | optional | |
| tags | Tag | repeated | |
| custom_fields | DeviceBay.CustomFieldsEntry | repeated |
DeviceBay.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
DeviceRole
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| color | string | optional | |
| vm_role | bool | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | DeviceRole.CustomFieldsEntry | repeated | |
| parent | DeviceRole | optional | |
| comments | string | optional |
DeviceRole.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
DeviceType
| Field | Type | Label | Description |
|---|---|---|---|
| manufacturer | Manufacturer | ||
| default_platform | Platform | optional | |
| model | string | ||
| slug | string | ||
| part_number | string | optional | |
| u_height | double | optional | |
| exclude_from_utilization | bool | optional | |
| is_full_depth | bool | optional | |
| subdevice_role | string | optional | |
| airflow | string | optional | |
| weight | double | optional | |
| weight_unit | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | DeviceType.CustomFieldsEntry | repeated |
DeviceType.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Entity
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| asn | ASN | ||
| asn_range | ASNRange | ||
| aggregate | Aggregate | ||
| cable | Cable | ||
| cable_path | CablePath | ||
| cable_termination | CableTermination | ||
| circuit | Circuit | ||
| circuit_group | CircuitGroup | ||
| circuit_group_assignment | CircuitGroupAssignment | ||
| circuit_termination | CircuitTermination | ||
| circuit_type | CircuitType | ||
| cluster | Cluster | ||
| cluster_group | ClusterGroup | ||
| cluster_type | ClusterType | ||
| console_port | ConsolePort | ||
| console_server_port | ConsoleServerPort | ||
| contact | Contact | ||
| contact_assignment | ContactAssignment | ||
| contact_group | ContactGroup | ||
| contact_role | ContactRole | ||
| device | Device | ||
| device_bay | DeviceBay | ||
| device_role | DeviceRole | ||
| device_type | DeviceType | ||
| fhrp_group | FHRPGroup | ||
| fhrp_group_assignment | FHRPGroupAssignment | ||
| front_port | FrontPort | ||
| ike_policy | IKEPolicy | ||
| ike_proposal | IKEProposal | ||
| ip_address | IPAddress | ||
| ip_range | IPRange | ||
| ip_sec_policy | IPSecPolicy | ||
| ip_sec_profile | IPSecProfile | ||
| ip_sec_proposal | IPSecProposal | ||
| interface | Interface | ||
| inventory_item | InventoryItem | ||
| inventory_item_role | InventoryItemRole | ||
| l2vpn | L2VPN | ||
| l2vpn_termination | L2VPNTermination | ||
| location | Location | ||
| mac_address | MACAddress | ||
| manufacturer | Manufacturer | ||
| module | Module | ||
| module_bay | ModuleBay | ||
| module_type | ModuleType | ||
| platform | Platform | ||
| power_feed | PowerFeed | ||
| power_outlet | PowerOutlet | ||
| power_panel | PowerPanel | ||
| power_port | PowerPort | ||
| prefix | Prefix | ||
| provider | Provider | ||
| provider_account | ProviderAccount | ||
| provider_network | ProviderNetwork | ||
| rir | RIR | ||
| rack | Rack | ||
| rack_reservation | RackReservation | ||
| rack_role | RackRole | ||
| rack_type | RackType | ||
| rear_port | RearPort | ||
| region | Region | ||
| role | Role | ||
| route_target | RouteTarget | ||
| service | Service | ||
| site | Site | ||
| site_group | SiteGroup | ||
| tag | Tag | ||
| tenant | Tenant | ||
| tenant_group | TenantGroup | ||
| tunnel | Tunnel | ||
| tunnel_group | TunnelGroup | ||
| tunnel_termination | TunnelTermination | ||
| vlan | VLAN | ||
| vlan_group | VLANGroup | ||
| vlan_translation_policy | VLANTranslationPolicy | ||
| vlan_translation_rule | VLANTranslationRule | ||
| vm_interface | VMInterface | ||
| vrf | VRF | ||
| virtual_chassis | VirtualChassis | ||
| virtual_circuit | VirtualCircuit | ||
| virtual_circuit_termination | VirtualCircuitTermination | ||
| virtual_circuit_type | VirtualCircuitType | ||
| virtual_device_context | VirtualDeviceContext | ||
| virtual_disk | VirtualDisk | ||
| virtual_machine | VirtualMachine | ||
| wireless_lan | WirelessLAN | ||
| wireless_lan_group | WirelessLANGroup | ||
| wireless_link | WirelessLink | ||
| custom_field | CustomField | ||
| custom_field_choice_set | CustomFieldChoiceSet | ||
| journal_entry | JournalEntry | ||
| module_type_profile | ModuleTypeProfile | ||
| custom_link | CustomLink |
FHRPGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | optional | |
| protocol | string | ||
| group_id | int64 | ||
| auth_type | string | optional | |
| auth_key | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | FHRPGroup.CustomFieldsEntry | repeated |
FHRPGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
FHRPGroupAssignment
| Field | Type | Label | Description |
|---|---|---|---|
| group | FHRPGroup | ||
| interface_asn | ASN | ||
| interface_asn_range | ASNRange | ||
| interface_aggregate | Aggregate | ||
| interface_cable | Cable | ||
| interface_cable_path | CablePath | ||
| interface_cable_termination | CableTermination | ||
| interface_circuit | Circuit | ||
| interface_circuit_group | CircuitGroup | ||
| interface_circuit_group_assignment | CircuitGroupAssignment | ||
| interface_circuit_termination | CircuitTermination | ||
| interface_circuit_type | CircuitType | ||
| interface_cluster | Cluster | ||
| interface_cluster_group | ClusterGroup | ||
| interface_cluster_type | ClusterType | ||
| interface_console_port | ConsolePort | ||
| interface_console_server_port | ConsoleServerPort | ||
| interface_contact | Contact | ||
| interface_contact_assignment | ContactAssignment | ||
| interface_contact_group | ContactGroup | ||
| interface_contact_role | ContactRole | ||
| interface_device | Device | ||
| interface_device_bay | DeviceBay | ||
| interface_device_role | DeviceRole | ||
| interface_device_type | DeviceType | ||
| interface_fhrp_group | FHRPGroup | ||
| interface_fhrp_group_assignment | FHRPGroupAssignment | ||
| interface_front_port | FrontPort | ||
| interface_ike_policy | IKEPolicy | ||
| interface_ike_proposal | IKEProposal | ||
| interface_ip_address | IPAddress | ||
| interface_ip_range | IPRange | ||
| interface_ip_sec_policy | IPSecPolicy | ||
| interface_ip_sec_profile | IPSecProfile | ||
| interface_ip_sec_proposal | IPSecProposal | ||
| interface_interface | Interface | ||
| interface_inventory_item | InventoryItem | ||
| interface_inventory_item_role | InventoryItemRole | ||
| interface_l2vpn | L2VPN | ||
| interface_l2vpn_termination | L2VPNTermination | ||
| interface_location | Location | ||
| interface_mac_address | MACAddress | ||
| interface_manufacturer | Manufacturer | ||
| interface_module | Module | ||
| interface_module_bay | ModuleBay | ||
| interface_module_type | ModuleType | ||
| interface_platform | Platform | ||
| interface_power_feed | PowerFeed | ||
| interface_power_outlet | PowerOutlet | ||
| interface_power_panel | PowerPanel | ||
| interface_power_port | PowerPort | ||
| interface_prefix | Prefix | ||
| interface_provider | Provider | ||
| interface_provider_account | ProviderAccount | ||
| interface_provider_network | ProviderNetwork | ||
| interface_rir | RIR | ||
| interface_rack | Rack | ||
| interface_rack_reservation | RackReservation | ||
| interface_rack_role | RackRole | ||
| interface_rack_type | RackType | ||
| interface_rear_port | RearPort | ||
| interface_region | Region | ||
| interface_role | Role | ||
| interface_route_target | RouteTarget | ||
| interface_service | Service | ||
| interface_site | Site | ||
| interface_site_group | SiteGroup | ||
| interface_tag | Tag | ||
| interface_tenant | Tenant | ||
| interface_tenant_group | TenantGroup | ||
| interface_tunnel | Tunnel | ||
| interface_tunnel_group | TunnelGroup | ||
| interface_tunnel_termination | TunnelTermination | ||
| interface_vlan | VLAN | ||
| interface_vlan_group | VLANGroup | ||
| interface_vlan_translation_policy | VLANTranslationPolicy | ||
| interface_vlan_translation_rule | VLANTranslationRule | ||
| interface_vm_interface | VMInterface | ||
| interface_vrf | VRF | ||
| interface_virtual_chassis | VirtualChassis | ||
| interface_virtual_circuit | VirtualCircuit | ||
| interface_virtual_circuit_termination | VirtualCircuitTermination | ||
| interface_virtual_circuit_type | VirtualCircuitType | ||
| interface_virtual_device_context | VirtualDeviceContext | ||
| interface_virtual_disk | VirtualDisk | ||
| interface_virtual_machine | VirtualMachine | ||
| interface_wireless_lan | WirelessLAN | ||
| interface_wireless_lan_group | WirelessLANGroup | ||
| interface_wireless_link | WirelessLink | ||
| interface_custom_field | CustomField | ||
| interface_custom_field_choice_set | CustomFieldChoiceSet | ||
| interface_journal_entry | JournalEntry | ||
| interface_module_type_profile | ModuleTypeProfile | ||
| interface_custom_link | CustomLink | ||
| priority | int64 |
FrontPort
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | ||
| color | string | optional | |
| rear_port | RearPort | ||
| rear_port_position | int64 | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | FrontPort.CustomFieldsEntry | repeated |
FrontPort.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
GenericObject
| Field | Type | Label | Description |
|---|---|---|---|
| object_asn | ASN | ||
| object_asn_range | ASNRange | ||
| object_aggregate | Aggregate | ||
| object_cable | Cable | ||
| object_cable_path | CablePath | ||
| object_cable_termination | CableTermination | ||
| object_circuit | Circuit | ||
| object_circuit_group | CircuitGroup | ||
| object_circuit_group_assignment | CircuitGroupAssignment | ||
| object_circuit_termination | CircuitTermination | ||
| object_circuit_type | CircuitType | ||
| object_cluster | Cluster | ||
| object_cluster_group | ClusterGroup | ||
| object_cluster_type | ClusterType | ||
| object_console_port | ConsolePort | ||
| object_console_server_port | ConsoleServerPort | ||
| object_contact | Contact | ||
| object_contact_assignment | ContactAssignment | ||
| object_contact_group | ContactGroup | ||
| object_contact_role | ContactRole | ||
| object_device | Device | ||
| object_device_bay | DeviceBay | ||
| object_device_role | DeviceRole | ||
| object_device_type | DeviceType | ||
| object_fhrp_group | FHRPGroup | ||
| object_fhrp_group_assignment | FHRPGroupAssignment | ||
| object_front_port | FrontPort | ||
| object_ike_policy | IKEPolicy | ||
| object_ike_proposal | IKEProposal | ||
| object_ip_address | IPAddress | ||
| object_ip_range | IPRange | ||
| object_ip_sec_policy | IPSecPolicy | ||
| object_ip_sec_profile | IPSecProfile | ||
| object_ip_sec_proposal | IPSecProposal | ||
| object_interface | Interface | ||
| object_inventory_item | InventoryItem | ||
| object_inventory_item_role | InventoryItemRole | ||
| object_l2vpn | L2VPN | ||
| object_l2vpn_termination | L2VPNTermination | ||
| object_location | Location | ||
| object_mac_address | MACAddress | ||
| object_manufacturer | Manufacturer | ||
| object_module | Module | ||
| object_module_bay | ModuleBay | ||
| object_module_type | ModuleType | ||
| object_platform | Platform | ||
| object_power_feed | PowerFeed | ||
| object_power_outlet | PowerOutlet | ||
| object_power_panel | PowerPanel | ||
| object_power_port | PowerPort | ||
| object_prefix | Prefix | ||
| object_provider | Provider | ||
| object_provider_account | ProviderAccount | ||
| object_provider_network | ProviderNetwork | ||
| object_rir | RIR | ||
| object_rack | Rack | ||
| object_rack_reservation | RackReservation | ||
| object_rack_role | RackRole | ||
| object_rack_type | RackType | ||
| object_rear_port | RearPort | ||
| object_region | Region | ||
| object_role | Role | ||
| object_route_target | RouteTarget | ||
| object_service | Service | ||
| object_site | Site | ||
| object_site_group | SiteGroup | ||
| object_tag | Tag | ||
| object_tenant | Tenant | ||
| object_tenant_group | TenantGroup | ||
| object_tunnel | Tunnel | ||
| object_tunnel_group | TunnelGroup | ||
| object_tunnel_termination | TunnelTermination | ||
| object_vlan | VLAN | ||
| object_vlan_group | VLANGroup | ||
| object_vlan_translation_policy | VLANTranslationPolicy | ||
| object_vlan_translation_rule | VLANTranslationRule | ||
| object_vm_interface | VMInterface | ||
| object_vrf | VRF | ||
| object_virtual_chassis | VirtualChassis | ||
| object_virtual_circuit | VirtualCircuit | ||
| object_virtual_circuit_termination | VirtualCircuitTermination | ||
| object_virtual_circuit_type | VirtualCircuitType | ||
| object_virtual_device_context | VirtualDeviceContext | ||
| object_virtual_disk | VirtualDisk | ||
| object_virtual_machine | VirtualMachine | ||
| object_wireless_lan | WirelessLAN | ||
| object_wireless_lan_group | WirelessLANGroup | ||
| object_wireless_link | WirelessLink | ||
| object_custom_field | CustomField | ||
| object_custom_field_choice_set | CustomFieldChoiceSet | ||
| object_journal_entry | JournalEntry | ||
| object_module_type_profile | ModuleTypeProfile | ||
| object_custom_link | CustomLink |
IKEPolicy
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| version | int64 | ||
| mode | string | optional | |
| preshared_key | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | IKEPolicy.CustomFieldsEntry | repeated | |
| proposals | IKEProposal | repeated |
IKEPolicy.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IKEProposal
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| authentication_method | string | ||
| encryption_algorithm | string | ||
| authentication_algorithm | string | optional | |
| group | int64 | ||
| sa_lifetime | int64 | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | IKEProposal.CustomFieldsEntry | repeated |
IKEProposal.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IPAddress
| Field | Type | Label | Description |
|---|---|---|---|
| address | string | ||
| vrf | VRF | optional | |
| tenant | Tenant | optional | |
| status | string | optional | |
| role | string | optional | |
| assigned_object_fhrp_group | FHRPGroup | ||
| assigned_object_interface | Interface | ||
| assigned_object_vm_interface | VMInterface | ||
| nat_inside | IPAddress | optional | |
| dns_name | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | IPAddress.CustomFieldsEntry | repeated |
IPAddress.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IPRange
| Field | Type | Label | Description |
|---|---|---|---|
| start_address | string | ||
| end_address | string | ||
| vrf | VRF | optional | |
| tenant | Tenant | optional | |
| status | string | optional | |
| role | Role | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| mark_utilized | bool | optional | |
| custom_fields | IPRange.CustomFieldsEntry | repeated | |
| mark_populated | bool | optional |
IPRange.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IPSecPolicy
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| pfs_group | int64 | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | IPSecPolicy.CustomFieldsEntry | repeated | |
| proposals | IPSecProposal | repeated |
IPSecPolicy.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IPSecProfile
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| mode | string | ||
| ike_policy | IKEPolicy | ||
| ipsec_policy | IPSecPolicy | ||
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | IPSecProfile.CustomFieldsEntry | repeated |
IPSecProfile.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IPSecProposal
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| encryption_algorithm | string | optional | |
| authentication_algorithm | string | optional | |
| sa_lifetime_seconds | int64 | optional | |
| sa_lifetime_data | int64 | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | IPSecProposal.CustomFieldsEntry | repeated |
IPSecProposal.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IngestRequest
| Field | Type | Label | Description |
|---|---|---|---|
| stream | string | ||
| entities | Entity | repeated | |
| id | string | ||
| producer_app_name | string | ||
| producer_app_version | string | ||
| sdk_name | string | ||
| sdk_version | string |
IngestResponse
| Field | Type | Label | Description |
|---|---|---|---|
| errors | string | repeated |
Interface
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | ||
| enabled | bool | optional | |
| parent | Interface | optional | |
| bridge | Interface | optional | |
| lag | Interface | optional | |
| mtu | int64 | optional | |
| primary_mac_address | MACAddress | optional | |
| speed | int64 | optional | |
| duplex | string | optional | |
| wwn | string | optional | |
| mgmt_only | bool | optional | |
| description | string | optional | |
| mode | string | optional | |
| rf_role | string | optional | |
| rf_channel | string | optional | |
| poe_mode | string | optional | |
| poe_type | string | optional | |
| rf_channel_frequency | double | optional | |
| rf_channel_width | double | optional | |
| tx_power | int64 | optional | |
| untagged_vlan | VLAN | optional | |
| qinq_svlan | VLAN | optional | |
| vlan_translation_policy | VLANTranslationPolicy | optional | |
| mark_connected | bool | optional | |
| vrf | VRF | optional | |
| tags | Tag | repeated | |
| custom_fields | Interface.CustomFieldsEntry | repeated | |
| vdcs | VirtualDeviceContext | repeated | |
| tagged_vlans | VLAN | repeated | |
| wireless_lans | WirelessLAN | repeated |
Interface.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
InventoryItem
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| parent | InventoryItem | optional | |
| name | string | ||
| label | string | optional | |
| status | string | optional | |
| role | InventoryItemRole | optional | |
| manufacturer | Manufacturer | optional | |
| part_id | string | optional | |
| serial | string | optional | |
| asset_tag | string | optional | |
| discovered | bool | optional | |
| description | string | optional | |
| component_console_port | ConsolePort | ||
| component_console_server_port | ConsoleServerPort | ||
| component_front_port | FrontPort | ||
| component_interface | Interface | ||
| component_power_outlet | PowerOutlet | ||
| component_power_port | PowerPort | ||
| component_rear_port | RearPort | ||
| tags | Tag | repeated | |
| custom_fields | InventoryItem.CustomFieldsEntry | repeated |
InventoryItem.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
InventoryItemRole
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| color | string | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | InventoryItemRole.CustomFieldsEntry | repeated |
InventoryItemRole.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
JournalEntry
| Field | Type | Label | Description |
|---|---|---|---|
| assigned_object_asn | ASN | ||
| assigned_object_asn_range | ASNRange | ||
| assigned_object_aggregate | Aggregate | ||
| assigned_object_cable | Cable | ||
| assigned_object_cable_path | CablePath | ||
| assigned_object_cable_termination | CableTermination | ||
| assigned_object_circuit | Circuit | ||
| assigned_object_circuit_group | CircuitGroup | ||
| assigned_object_circuit_group_assignment | CircuitGroupAssignment | ||
| assigned_object_circuit_termination | CircuitTermination | ||
| assigned_object_circuit_type | CircuitType | ||
| assigned_object_cluster | Cluster | ||
| assigned_object_cluster_group | ClusterGroup | ||
| assigned_object_cluster_type | ClusterType | ||
| assigned_object_console_port | ConsolePort | ||
| assigned_object_console_server_port | ConsoleServerPort | ||
| assigned_object_contact | Contact | ||
| assigned_object_contact_assignment | ContactAssignment | ||
| assigned_object_contact_group | ContactGroup | ||
| assigned_object_contact_role | ContactRole | ||
| assigned_object_custom_field | CustomField | ||
| assigned_object_custom_field_choice_set | CustomFieldChoiceSet | ||
| assigned_object_device | Device | ||
| assigned_object_device_bay | DeviceBay | ||
| assigned_object_device_role | DeviceRole | ||
| assigned_object_device_type | DeviceType | ||
| assigned_object_fhrp_group | FHRPGroup | ||
| assigned_object_fhrp_group_assignment | FHRPGroupAssignment | ||
| assigned_object_front_port | FrontPort | ||
| assigned_object_ike_policy | IKEPolicy | ||
| assigned_object_ike_proposal | IKEProposal | ||
| assigned_object_ip_address | IPAddress | ||
| assigned_object_ip_range | IPRange | ||
| assigned_object_ip_sec_policy | IPSecPolicy | ||
| assigned_object_ip_sec_profile | IPSecProfile | ||
| assigned_object_ip_sec_proposal | IPSecProposal | ||
| assigned_object_interface | Interface | ||
| assigned_object_inventory_item | InventoryItem | ||
| assigned_object_inventory_item_role | InventoryItemRole | ||
| assigned_object_journal_entry | JournalEntry | ||
| assigned_object_l2vpn | L2VPN | ||
| assigned_object_l2vpn_termination | L2VPNTermination | ||
| assigned_object_location | Location | ||
| assigned_object_mac_address | MACAddress | ||
| assigned_object_manufacturer | Manufacturer | ||
| assigned_object_module | Module | ||
| assigned_object_module_bay | ModuleBay | ||
| assigned_object_module_type | ModuleType | ||
| assigned_object_module_type_profile | ModuleTypeProfile | ||
| assigned_object_platform | Platform | ||
| assigned_object_power_feed | PowerFeed | ||
| assigned_object_power_outlet | PowerOutlet | ||
| assigned_object_power_panel | PowerPanel | ||
| assigned_object_power_port | PowerPort | ||
| assigned_object_prefix | Prefix | ||
| assigned_object_provider | Provider | ||
| assigned_object_provider_account | ProviderAccount | ||
| assigned_object_provider_network | ProviderNetwork | ||
| assigned_object_rir | RIR | ||
| assigned_object_rack | Rack | ||
| assigned_object_rack_reservation | RackReservation | ||
| assigned_object_rack_role | RackRole | ||
| assigned_object_rack_type | RackType | ||
| assigned_object_rear_port | RearPort | ||
| assigned_object_region | Region | ||
| assigned_object_role | Role | ||
| assigned_object_route_target | RouteTarget | ||
| assigned_object_service | Service | ||
| assigned_object_site | Site | ||
| assigned_object_site_group | SiteGroup | ||
| assigned_object_tag | Tag | ||
| assigned_object_tenant | Tenant | ||
| assigned_object_tenant_group | TenantGroup | ||
| assigned_object_tunnel | Tunnel | ||
| assigned_object_tunnel_group | TunnelGroup | ||
| assigned_object_tunnel_termination | TunnelTermination | ||
| assigned_object_vlan | VLAN | ||
| assigned_object_vlan_group | VLANGroup | ||
| assigned_object_vlan_translation_policy | VLANTranslationPolicy | ||
| assigned_object_vlan_translation_rule | VLANTranslationRule | ||
| assigned_object_vm_interface | VMInterface | ||
| assigned_object_vrf | VRF | ||
| assigned_object_virtual_chassis | VirtualChassis | ||
| assigned_object_virtual_circuit | VirtualCircuit | ||
| assigned_object_virtual_circuit_termination | VirtualCircuitTermination | ||
| assigned_object_virtual_circuit_type | VirtualCircuitType | ||
| assigned_object_virtual_device_context | VirtualDeviceContext | ||
| assigned_object_virtual_disk | VirtualDisk | ||
| assigned_object_virtual_machine | VirtualMachine | ||
| assigned_object_wireless_lan | WirelessLAN | ||
| assigned_object_wireless_lan_group | WirelessLANGroup | ||
| assigned_object_wireless_link | WirelessLink | ||
| assigned_object_custom_link | CustomLink | ||
| kind | string | optional | |
| comments | string | ||
| tags | Tag | repeated | |
| custom_fields | JournalEntry.CustomFieldsEntry | repeated |
JournalEntry.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
L2VPN
| Field | Type | Label | Description |
|---|---|---|---|
| identifier | int64 | optional | |
| name | string | ||
| slug | string | ||
| type | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tenant | Tenant | optional | |
| tags | Tag | repeated | |
| custom_fields | L2VPN.CustomFieldsEntry | repeated | |
| import_targets | RouteTarget | repeated | |
| export_targets | RouteTarget | repeated | |
| status | string | optional |
L2VPN.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
L2VPNTermination
| Field | Type | Label | Description |
|---|---|---|---|
| l2vpn | L2VPN | ||
| assigned_object_interface | Interface | ||
| assigned_object_vlan | VLAN | ||
| assigned_object_vm_interface | VMInterface | ||
| assigned_object_asn | ASN | ||
| assigned_object_asn_range | ASNRange | ||
| assigned_object_aggregate | Aggregate | ||
| assigned_object_cable | Cable | ||
| assigned_object_cable_path | CablePath | ||
| assigned_object_cable_termination | CableTermination | ||
| assigned_object_circuit | Circuit | ||
| assigned_object_circuit_group | CircuitGroup | ||
| assigned_object_circuit_group_assignment | CircuitGroupAssignment | ||
| assigned_object_circuit_termination | CircuitTermination | ||
| assigned_object_circuit_type | CircuitType | ||
| assigned_object_cluster | Cluster | ||
| assigned_object_cluster_group | ClusterGroup | ||
| assigned_object_cluster_type | ClusterType | ||
| assigned_object_console_port | ConsolePort | ||
| assigned_object_console_server_port | ConsoleServerPort | ||
| assigned_object_contact | Contact | ||
| assigned_object_contact_assignment | ContactAssignment | ||
| assigned_object_contact_group | ContactGroup | ||
| assigned_object_contact_role | ContactRole | ||
| assigned_object_custom_field | CustomField | ||
| assigned_object_custom_field_choice_set | CustomFieldChoiceSet | ||
| assigned_object_device | Device | ||
| assigned_object_device_bay | DeviceBay | ||
| assigned_object_device_role | DeviceRole | ||
| assigned_object_device_type | DeviceType | ||
| assigned_object_fhrp_group | FHRPGroup | ||
| assigned_object_fhrp_group_assignment | FHRPGroupAssignment | ||
| assigned_object_front_port | FrontPort | ||
| assigned_object_ike_policy | IKEPolicy | ||
| assigned_object_ike_proposal | IKEProposal | ||
| assigned_object_ip_address | IPAddress | ||
| assigned_object_ip_range | IPRange | ||
| assigned_object_ip_sec_policy | IPSecPolicy | ||
| assigned_object_ip_sec_profile | IPSecProfile | ||
| assigned_object_ip_sec_proposal | IPSecProposal | ||
| assigned_object_inventory_item | InventoryItem | ||
| assigned_object_inventory_item_role | InventoryItemRole | ||
| assigned_object_journal_entry | JournalEntry | ||
| assigned_object_l2vpn | L2VPN | ||
| assigned_object_l2vpn_termination | L2VPNTermination | ||
| assigned_object_location | Location | ||
| assigned_object_mac_address | MACAddress | ||
| assigned_object_manufacturer | Manufacturer | ||
| assigned_object_module | Module | ||
| assigned_object_module_bay | ModuleBay | ||
| assigned_object_module_type | ModuleType | ||
| assigned_object_module_type_profile | ModuleTypeProfile | ||
| assigned_object_platform | Platform | ||
| assigned_object_power_feed | PowerFeed | ||
| assigned_object_power_outlet | PowerOutlet | ||
| assigned_object_power_panel | PowerPanel | ||
| assigned_object_power_port | PowerPort | ||
| assigned_object_prefix | Prefix | ||
| assigned_object_provider | Provider | ||
| assigned_object_provider_account | ProviderAccount | ||
| assigned_object_provider_network | ProviderNetwork | ||
| assigned_object_rir | RIR | ||
| assigned_object_rack | Rack | ||
| assigned_object_rack_reservation | RackReservation | ||
| assigned_object_rack_role | RackRole | ||
| assigned_object_rack_type | RackType | ||
| assigned_object_rear_port | RearPort | ||
| assigned_object_region | Region | ||
| assigned_object_role | Role | ||
| assigned_object_route_target | RouteTarget | ||
| assigned_object_service | Service | ||
| assigned_object_site | Site | ||
| assigned_object_site_group | SiteGroup | ||
| assigned_object_tag | Tag | ||
| assigned_object_tenant | Tenant | ||
| assigned_object_tenant_group | TenantGroup | ||
| assigned_object_tunnel | Tunnel | ||
| assigned_object_tunnel_group | TunnelGroup | ||
| assigned_object_tunnel_termination | TunnelTermination | ||
| assigned_object_vlan_group | VLANGroup | ||
| assigned_object_vlan_translation_policy | VLANTranslationPolicy | ||
| assigned_object_vlan_translation_rule | VLANTranslationRule | ||
| assigned_object_vrf | VRF | ||
| assigned_object_virtual_chassis | VirtualChassis | ||
| assigned_object_virtual_circuit | VirtualCircuit | ||
| assigned_object_virtual_circuit_termination | VirtualCircuitTermination | ||
| assigned_object_virtual_circuit_type | VirtualCircuitType | ||
| assigned_object_virtual_device_context | VirtualDeviceContext | ||
| assigned_object_virtual_disk | VirtualDisk | ||
| assigned_object_virtual_machine | VirtualMachine | ||
| assigned_object_wireless_lan | WirelessLAN | ||
| assigned_object_wireless_lan_group | WirelessLANGroup | ||
| assigned_object_wireless_link | WirelessLink | ||
| assigned_object_custom_link | CustomLink | ||
| tags | Tag | repeated | |
| custom_fields | L2VPNTermination.CustomFieldsEntry | repeated |
L2VPNTermination.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Location
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| site | Site | ||
| parent | Location | optional | |
| status | string | optional | |
| tenant | Tenant | optional | |
| facility | string | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Location.CustomFieldsEntry | repeated | |
| comments | string | optional |
Location.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
MACAddress
| Field | Type | Label | Description |
|---|---|---|---|
| mac_address | string | ||
| assigned_object_interface | Interface | ||
| assigned_object_vm_interface | VMInterface | ||
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | MACAddress.CustomFieldsEntry | repeated |
MACAddress.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Manufacturer
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Manufacturer.CustomFieldsEntry | repeated |
Manufacturer.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Module
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module_bay | ModuleBay | ||
| module_type | ModuleType | ||
| status | string | optional | |
| serial | string | optional | |
| asset_tag | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Module.CustomFieldsEntry | repeated |
Module.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ModuleBay
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| installed_module | Module | optional | |
| label | string | optional | |
| position | string | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ModuleBay.CustomFieldsEntry | repeated |
ModuleBay.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ModuleType
| Field | Type | Label | Description |
|---|---|---|---|
| manufacturer | Manufacturer | ||
| model | string | ||
| part_number | string | optional | |
| airflow | string | optional | |
| weight | double | optional | |
| weight_unit | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ModuleType.CustomFieldsEntry | repeated | |
| profile | ModuleTypeProfile | optional | |
| attributes | string | optional |
ModuleType.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ModuleTypeProfile
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional | |
| schema | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ModuleTypeProfile.CustomFieldsEntry | repeated |
ModuleTypeProfile.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Platform
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| manufacturer | Manufacturer | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Platform.CustomFieldsEntry | repeated | |
| parent | Platform | optional | |
| comments | string | optional |
Platform.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
PowerFeed
| Field | Type | Label | Description |
|---|---|---|---|
| power_panel | PowerPanel | ||
| rack | Rack | optional | |
| name | string | ||
| status | string | optional | |
| type | string | optional | |
| supply | string | optional | |
| phase | string | optional | |
| voltage | int64 | optional | |
| amperage | int64 | optional | |
| max_utilization | int64 | optional | |
| mark_connected | bool | optional | |
| description | string | optional | |
| tenant | Tenant | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | PowerFeed.CustomFieldsEntry | repeated |
PowerFeed.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
PowerOutlet
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | optional | |
| color | string | optional | |
| power_port | PowerPort | optional | |
| feed_leg | string | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | PowerOutlet.CustomFieldsEntry | repeated | |
| status | string | optional |
PowerOutlet.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
PowerPanel
| Field | Type | Label | Description |
|---|---|---|---|
| site | Site | ||
| location | Location | optional | |
| name | string | ||
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | PowerPanel.CustomFieldsEntry | repeated |
PowerPanel.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
PowerPort
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | optional | |
| maximum_draw | int64 | optional | |
| allocated_draw | int64 | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | PowerPort.CustomFieldsEntry | repeated |
PowerPort.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Prefix
| Field | Type | Label | Description |
|---|---|---|---|
| prefix | string | ||
| vrf | VRF | optional | |
| scope_location | Location | ||
| scope_region | Region | ||
| scope_site | Site | ||
| scope_site_group | SiteGroup | ||
| tenant | Tenant | optional | |
| vlan | VLAN | optional | |
| status | string | optional | |
| role | Role | optional | |
| is_pool | bool | optional | |
| mark_utilized | bool | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Prefix.CustomFieldsEntry | repeated |
Prefix.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Provider
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Provider.CustomFieldsEntry | repeated | |
| accounts | ProviderAccount | repeated | |
| asns | ASN | repeated |
Provider.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ProviderAccount
| Field | Type | Label | Description |
|---|---|---|---|
| provider | Provider | ||
| name | string | optional | |
| account | string | ||
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ProviderAccount.CustomFieldsEntry | repeated |
ProviderAccount.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
ProviderNetwork
| Field | Type | Label | Description |
|---|---|---|---|
| provider | Provider | ||
| name | string | ||
| service_id | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | ProviderNetwork.CustomFieldsEntry | repeated |
ProviderNetwork.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
RIR
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| is_private | bool | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | RIR.CustomFieldsEntry | repeated |
RIR.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Rack
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| facility_id | string | optional | |
| site | Site | ||
| location | Location | optional | |
| tenant | Tenant | optional | |
| status | string | optional | |
| role | RackRole | optional | |
| serial | string | optional | |
| asset_tag | string | optional | |
| rack_type | RackType | optional | |
| form_factor | string | optional | |
| width | int64 | optional | |
| u_height | int64 | optional | |
| starting_unit | int64 | optional | |
| weight | double | optional | |
| max_weight | int64 | optional | |
| weight_unit | string | optional | |
| desc_units | bool | optional | |
| outer_width | int64 | optional | |
| outer_depth | int64 | optional | |
| outer_unit | string | optional | |
| mounting_depth | int64 | optional | |
| airflow | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Rack.CustomFieldsEntry | repeated | |
| outer_height | int64 | optional |
Rack.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
RackReservation
| Field | Type | Label | Description |
|---|---|---|---|
| rack | Rack | ||
| units | int64 | repeated | |
| tenant | Tenant | optional | |
| description | string | ||
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | RackReservation.CustomFieldsEntry | repeated | |
| status | string | optional |
RackReservation.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
RackRole
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| color | string | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | RackRole.CustomFieldsEntry | repeated |
RackRole.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
RackType
| Field | Type | Label | Description |
|---|---|---|---|
| manufacturer | Manufacturer | ||
| model | string | ||
| slug | string | ||
| description | string | optional | |
| form_factor | string | optional | |
| width | int64 | optional | |
| u_height | int64 | optional | |
| starting_unit | int64 | optional | |
| desc_units | bool | optional | |
| outer_width | int64 | optional | |
| outer_depth | int64 | optional | |
| outer_unit | string | optional | |
| weight | double | optional | |
| max_weight | int64 | optional | |
| weight_unit | string | optional | |
| mounting_depth | int64 | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | RackType.CustomFieldsEntry | repeated | |
| outer_height | int64 | optional |
RackType.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
RearPort
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | ||
| module | Module | optional | |
| name | string | ||
| label | string | optional | |
| type | string | ||
| color | string | optional | |
| positions | int64 | optional | |
| description | string | optional | |
| mark_connected | bool | optional | |
| tags | Tag | repeated | |
| custom_fields | RearPort.CustomFieldsEntry | repeated |
RearPort.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Region
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| parent | Region | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Region.CustomFieldsEntry | repeated | |
| comments | string | optional |
Region.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Role
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| weight | int64 | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Role.CustomFieldsEntry | repeated |
Role.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
RouteTarget
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| tenant | Tenant | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | RouteTarget.CustomFieldsEntry | repeated |
RouteTarget.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Service
| Field | Type | Label | Description |
|---|---|---|---|
| device | Device | optional | Deprecated. |
| virtual_machine | VirtualMachine | optional | Deprecated. |
| name | string | ||
| protocol | string | optional | |
| ports | int64 | repeated | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Service.CustomFieldsEntry | repeated | |
| ipaddresses | IPAddress | repeated | |
| parent_object_device | Device | ||
| parent_object_fhrp_group | FHRPGroup | ||
| parent_object_virtual_machine | VirtualMachine |
Service.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Site
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| status | string | optional | |
| region | Region | optional | |
| group | SiteGroup | optional | |
| tenant | Tenant | optional | |
| facility | string | optional | |
| time_zone | string | optional | |
| description | string | optional | |
| physical_address | string | optional | |
| shipping_address | string | optional | |
| latitude | double | optional | |
| longitude | double | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Site.CustomFieldsEntry | repeated | |
| asns | ASN | repeated |
Site.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
SiteGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| parent | SiteGroup | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | SiteGroup.CustomFieldsEntry | repeated | |
| comments | string | optional |
SiteGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Tag
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| color | string | optional | |
| description | string | optional | |
| weight | int64 | optional | |
| object_types | string | repeated |
Tenant
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| group | TenantGroup | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Tenant.CustomFieldsEntry | repeated |
Tenant.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
TenantGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| parent | TenantGroup | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | TenantGroup.CustomFieldsEntry | repeated | |
| comments | string | optional |
TenantGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
Tunnel
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| status | string | ||
| group | TunnelGroup | optional | |
| encapsulation | string | ||
| ipsec_profile | IPSecProfile | optional | |
| tenant | Tenant | optional | |
| tunnel_id | int64 | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | Tunnel.CustomFieldsEntry | repeated |
Tunnel.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
TunnelGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | TunnelGroup.CustomFieldsEntry | repeated |
TunnelGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
TunnelTermination
| Field | Type | Label | Description |
|---|---|---|---|
| tunnel | Tunnel | ||
| role | string | ||
| termination_asn | ASN | ||
| termination_asn_range | ASNRange | ||
| termination_aggregate | Aggregate | ||
| termination_cable | Cable | ||
| termination_cable_path | CablePath | ||
| termination_cable_termination | CableTermination | ||
| termination_circuit | Circuit | ||
| termination_circuit_group | CircuitGroup | ||
| termination_circuit_group_assignment | CircuitGroupAssignment | ||
| termination_circuit_termination | CircuitTermination | ||
| termination_circuit_type | CircuitType | ||
| termination_cluster | Cluster | ||
| termination_cluster_group | ClusterGroup | ||
| termination_cluster_type | ClusterType | ||
| termination_console_port | ConsolePort | ||
| termination_console_server_port | ConsoleServerPort | ||
| termination_contact | Contact | ||
| termination_contact_assignment | ContactAssignment | ||
| termination_contact_group | ContactGroup | ||
| termination_contact_role | ContactRole | ||
| termination_device | Device | ||
| termination_device_bay | DeviceBay | ||
| termination_device_role | DeviceRole | ||
| termination_device_type | DeviceType | ||
| termination_fhrp_group | FHRPGroup | ||
| termination_fhrp_group_assignment | FHRPGroupAssignment | ||
| termination_front_port | FrontPort | ||
| termination_ike_policy | IKEPolicy | ||
| termination_ike_proposal | IKEProposal | ||
| termination_ip_address | IPAddress | ||
| termination_ip_range | IPRange | ||
| termination_ip_sec_policy | IPSecPolicy | ||
| termination_ip_sec_profile | IPSecProfile | ||
| termination_ip_sec_proposal | IPSecProposal | ||
| termination_interface | Interface | ||
| termination_inventory_item | InventoryItem | ||
| termination_inventory_item_role | InventoryItemRole | ||
| termination_l2vpn | L2VPN | ||
| termination_l2vpn_termination | L2VPNTermination | ||
| termination_location | Location | ||
| termination_mac_address | MACAddress | ||
| termination_manufacturer | Manufacturer | ||
| termination_module | Module | ||
| termination_module_bay | ModuleBay | ||
| termination_module_type | ModuleType | ||
| termination_platform | Platform | ||
| termination_power_feed | PowerFeed | ||
| termination_power_outlet | PowerOutlet | ||
| termination_power_panel | PowerPanel | ||
| termination_power_port | PowerPort | ||
| termination_prefix | Prefix | ||
| termination_provider | Provider | ||
| termination_provider_account | ProviderAccount | ||
| termination_provider_network | ProviderNetwork | ||
| termination_rir | RIR | ||
| termination_rack | Rack | ||
| termination_rack_reservation | RackReservation | ||
| termination_rack_role | RackRole | ||
| termination_rack_type | RackType | ||
| termination_rear_port | RearPort | ||
| termination_region | Region | ||
| termination_role | Role | ||
| termination_route_target | RouteTarget | ||
| termination_service | Service | ||
| termination_site | Site | ||
| termination_site_group | SiteGroup | ||
| termination_tag | Tag | ||
| termination_tenant | Tenant | ||
| termination_tenant_group | TenantGroup | ||
| termination_tunnel | Tunnel | ||
| termination_tunnel_group | TunnelGroup | ||
| termination_tunnel_termination | TunnelTermination | ||
| termination_vlan | VLAN | ||
| termination_vlan_group | VLANGroup | ||
| termination_vlan_translation_policy | VLANTranslationPolicy | ||
| termination_vlan_translation_rule | VLANTranslationRule | ||
| termination_vm_interface | VMInterface | ||
| termination_vrf | VRF | ||
| termination_virtual_chassis | VirtualChassis | ||
| termination_virtual_circuit | VirtualCircuit | ||
| termination_virtual_circuit_termination | VirtualCircuitTermination | ||
| termination_virtual_circuit_type | VirtualCircuitType | ||
| termination_virtual_device_context | VirtualDeviceContext | ||
| termination_virtual_disk | VirtualDisk | ||
| termination_virtual_machine | VirtualMachine | ||
| termination_wireless_lan | WirelessLAN | ||
| termination_wireless_lan_group | WirelessLANGroup | ||
| termination_wireless_link | WirelessLink | ||
| termination_custom_field | CustomField | ||
| termination_custom_field_choice_set | CustomFieldChoiceSet | ||
| termination_journal_entry | JournalEntry | ||
| termination_module_type_profile | ModuleTypeProfile | ||
| termination_custom_link | CustomLink | ||
| outside_ip | IPAddress | optional | |
| tags | Tag | repeated | |
| custom_fields | TunnelTermination.CustomFieldsEntry | repeated |
TunnelTermination.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VLAN
| Field | Type | Label | Description |
|---|---|---|---|
| site | Site | optional | |
| group | VLANGroup | optional | |
| vid | int64 | ||
| name | string | ||
| tenant | Tenant | optional | |
| status | string | optional | |
| role | Role | optional | |
| description | string | optional | |
| qinq_role | string | optional | |
| qinq_svlan | VLAN | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VLAN.CustomFieldsEntry | repeated |
VLAN.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VLANGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| scope_cluster | Cluster | ||
| scope_cluster_group | ClusterGroup | ||
| scope_location | Location | ||
| scope_rack | Rack | ||
| scope_region | Region | ||
| scope_site | Site | ||
| scope_site_group | SiteGroup | ||
| vid_ranges | int64 | repeated | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VLANGroup.CustomFieldsEntry | repeated | |
| tenant | Tenant | optional |
VLANGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VLANTranslationPolicy
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| description | string | optional |
VLANTranslationRule
| Field | Type | Label | Description |
|---|---|---|---|
| policy | VLANTranslationPolicy | ||
| local_vid | int64 | ||
| remote_vid | int64 | ||
| description | string | optional |
VMInterface
| Field | Type | Label | Description |
|---|---|---|---|
| virtual_machine | VirtualMachine | ||
| name | string | ||
| enabled | bool | optional | |
| parent | VMInterface | optional | |
| bridge | VMInterface | optional | |
| mtu | int64 | optional | |
| primary_mac_address | MACAddress | optional | |
| description | string | optional | |
| mode | string | optional | |
| untagged_vlan | VLAN | optional | |
| qinq_svlan | VLAN | optional | |
| vlan_translation_policy | VLANTranslationPolicy | optional | |
| vrf | VRF | optional | |
| tags | Tag | repeated | |
| custom_fields | VMInterface.CustomFieldsEntry | repeated | |
| tagged_vlans | VLAN | repeated |
VMInterface.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VRF
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| rd | string | optional | |
| tenant | Tenant | optional | |
| enforce_unique | bool | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VRF.CustomFieldsEntry | repeated | |
| import_targets | RouteTarget | repeated | |
| export_targets | RouteTarget | repeated |
VRF.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualChassis
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| domain | string | optional | |
| master | Device | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VirtualChassis.CustomFieldsEntry | repeated |
VirtualChassis.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualCircuit
| Field | Type | Label | Description |
|---|---|---|---|
| cid | string | ||
| provider_network | ProviderNetwork | ||
| provider_account | ProviderAccount | optional | |
| type | VirtualCircuitType | ||
| status | string | optional | |
| tenant | Tenant | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VirtualCircuit.CustomFieldsEntry | repeated |
VirtualCircuit.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualCircuitTermination
| Field | Type | Label | Description |
|---|---|---|---|
| virtual_circuit | VirtualCircuit | ||
| role | string | optional | |
| interface | Interface | ||
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VirtualCircuitTermination.CustomFieldsEntry | repeated |
VirtualCircuitTermination.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualCircuitType
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| color | string | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VirtualCircuitType.CustomFieldsEntry | repeated |
VirtualCircuitType.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualDeviceContext
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| device | Device | ||
| identifier | int64 | optional | |
| tenant | Tenant | optional | |
| primary_ip4 | IPAddress | optional | |
| primary_ip6 | IPAddress | optional | |
| status | string | ||
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VirtualDeviceContext.CustomFieldsEntry | repeated |
VirtualDeviceContext.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualDisk
| Field | Type | Label | Description |
|---|---|---|---|
| virtual_machine | VirtualMachine | ||
| name | string | ||
| description | string | optional | |
| size | int64 | ||
| tags | Tag | repeated | |
| custom_fields | VirtualDisk.CustomFieldsEntry | repeated |
VirtualDisk.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
VirtualMachine
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| status | string | optional | |
| site | Site | optional | |
| cluster | Cluster | optional | |
| device | Device | optional | |
| serial | string | optional | |
| role | DeviceRole | optional | |
| tenant | Tenant | optional | |
| platform | Platform | optional | |
| primary_ip4 | IPAddress | optional | |
| primary_ip6 | IPAddress | optional | |
| vcpus | double | optional | |
| memory | int64 | optional | |
| disk | int64 | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | VirtualMachine.CustomFieldsEntry | repeated |
VirtualMachine.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
WirelessLAN
| Field | Type | Label | Description |
|---|---|---|---|
| ssid | string | ||
| description | string | optional | |
| group | WirelessLANGroup | optional | |
| status | string | optional | |
| vlan | VLAN | optional | |
| scope_location | Location | ||
| scope_region | Region | ||
| scope_site | Site | ||
| scope_site_group | SiteGroup | ||
| tenant | Tenant | optional | |
| auth_type | string | optional | |
| auth_cipher | string | optional | |
| auth_psk | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | WirelessLAN.CustomFieldsEntry | repeated |
WirelessLAN.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
WirelessLANGroup
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| slug | string | ||
| parent | WirelessLANGroup | optional | |
| description | string | optional | |
| tags | Tag | repeated | |
| custom_fields | WirelessLANGroup.CustomFieldsEntry | repeated | |
| comments | string | optional |
WirelessLANGroup.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
WirelessLink
| Field | Type | Label | Description |
|---|---|---|---|
| interface_a | Interface | ||
| interface_b | Interface | ||
| ssid | string | optional | |
| status | string | optional | |
| tenant | Tenant | optional | |
| auth_type | string | optional | |
| auth_cipher | string | optional | |
| auth_psk | string | optional | |
| distance | double | optional | |
| distance_unit | string | optional | |
| description | string | optional | |
| comments | string | optional | |
| tags | Tag | repeated | |
| custom_fields | WirelessLink.CustomFieldsEntry | repeated |
WirelessLink.CustomFieldsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | CustomFieldValue |
IngesterService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Ingest | IngestRequest | IngestResponse | Ingests data into the system |
diode/v1/reconciler.proto
Change
A change
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | ||
| object_type | string | ||
| object_primary_value | string | ||
| change_type | string | ||
| before | bytes | ||
| after | bytes |
ChangeSet
A change set
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | A change set ID | |
| data | bytes | Binary data representing the change set | |
| branch_id | string | optional | branch ID against which the change set was generated |
| deviation_name | string | optional | deviation name |
Deviation
A deviation
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | ||
| ingestion_ts | int64 | ||
| last_update_ts | int64 | ||
| name | string | ||
| source | string | ||
| state | State | ||
| object_type | string | ||
| branch_id | string | optional | |
| ingested_entity | Entity | ||
| error | DeviationError | ||
| changes | Change | repeated | |
| source_ts | int64 |
DeviationError
Deviation error
| Field | Type | Label | Description |
|---|---|---|---|
| message | string | ||
| code | string | ||
| details | bytes |
IngestionLog
An ingestion log
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | ||
| data_type | string | Deprecated. | |
| state | State | ||
| request_id | string | ||
| ingestion_ts | int64 | ||
| producer_app_name | string | ||
| producer_app_version | string | ||
| sdk_name | string | ||
| sdk_version | string | ||
| entity | Entity | ||
| error | DeviationError | ||
| change_set | ChangeSet | ||
| object_type | string | ||
| source_ts | int64 |
IngestionMetrics
Ingestion metrics
| Field | Type | Label | Description |
|---|---|---|---|
| total | int32 | ||
| queued | int32 | ||
| reconciled | int32 | ||
| failed | int32 | ||
| no_changes | int32 |
RetrieveDeviationByIDRequest
The request to retrieve deviation by ID
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | Deviation ID |
RetrieveDeviationByIDResponse
The response from the retrieve deviation by ID request
| Field | Type | Label | Description |
|---|---|---|---|
| deviation | Deviation | Deviation |
RetrieveDeviationsRequest
The request to retrieve deviations
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | int32 | optional | Number of deviations per page, default is 100 |
| page_token | string | Token to fetch the next page of results | |
| ingestion_ts_start | int64 | Optional start of ingestion timestamp range | |
| ingestion_ts_end | int64 | Optional end of ingestion timestamp range | |
| state | State | repeated | Optional filter by states |
| object_type | string | repeated | Optional filter by object types |
| branch_id | string | repeated | Optional filter by branch IDs |
RetrieveDeviationsResponse
The response from the retrieve deviations request
| Field | Type | Label | Description |
|---|---|---|---|
| deviations | Deviation | repeated | List of deviations |
| next_page_token | string | Token for the next page of results, if any |
RetrieveIngestionLogsRequest
The request to retrieve ingestion logs
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | int32 | optional | Number of logs per page, default is 100 |
| state | State | optional | Optional filter by state field |
| data_type | string | Deprecated. Optional filter by data type field | |
| request_id | string | Optional filter by request ID | |
| ingestion_ts_start | int64 | Optional start of ingestion timestamp range | |
| ingestion_ts_end | int64 | Optional end of ingestion timestamp range | |
| page_token | string | Token to fetch the next page of results | |
| only_metrics | bool | Flag to return only the ingestion metrics | |
| object_type | string | Optional filter by object type |
RetrieveIngestionLogsResponse
The response from the retrieve ingestion logs request
| Field | Type | Label | Description |
|---|---|---|---|
| logs | IngestionLog | repeated | List of ingestion logs |
| metrics | IngestionMetrics | ingestion metrics | |
| next_page_token | string | Token for the next page of results, if any |
State
| Name | Number | Description |
|---|---|---|
| STATE_UNSPECIFIED | 0 | |
| QUEUED | 1 | |
| OPEN | 2 | |
| APPLIED | 3 | |
| FAILED | 4 | |
| NO_CHANGES | 5 | |
| IGNORED | 6 | |
| ERRORED | 7 |
ReconcilerService
Reconciler service API
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| RetrieveIngestionLogs | RetrieveIngestionLogsRequest | RetrieveIngestionLogsResponse | Retrieves ingestion logs |
| RetrieveDeviations | RetrieveDeviationsRequest | RetrieveDeviationsResponse | Retrieve deviations |
| RetrieveDeviationByID | RetrieveDeviationByIDRequest | RetrieveDeviationByIDResponse | Retrieve deviation by ID |