api.monitor_network
¶
Cisco vManage Monitor Networks API Methods.
Module Contents¶
-
class
api.monitor_network.
MonitorNetwork
(session, host, port=443)[source]¶ Bases:
object
vManage Monitor Networks API
Responsible for GET methods against vManage Real Time Monitoring for network devices.
-
get_aaa_users
(self, system_ip)[source]¶ Provides AAA users for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device ARP table data.
- Return type
result (dict)
-
get_arp_table
(self, system_ip)[source]¶ Provides ARP entries for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device ARP table data.
- Return type
result (dict)
-
get_bfd_history
(self, system_ip, **kwargs)[source]¶ Provides BFD history for device.
- Parameters
system_ip (str) – Device System IP
remote_system_ip (str) – (Optional) Remote System IP
remote_color (str) – (Optional) Remote Color
- Returns
Device BFD history data.
- Return type
result (dict)
-
get_bfd_links
(self, system_ip, **kwargs)[source]¶ Provides BFD links for device.
- Parameters
system_ip (str) – Device System IP
state (str) – (Optional) State
- Returns
Device BFD links data.
- Return type
result (dict)
-
get_bfd_sessions
(self, system_ip, **kwargs)[source]¶ Provides BFD sessions for device.
- Parameters
system_ip (str) – Device System IP
remote_system_ip (str) – (Optional) Remote System IP
remote_color (str) – (Optional) Remote Color
local_color (str) – (Optional) Local Color
- Returns
Device BFD sessions data.
- Return type
result (dict)
-
get_bfd_device_state
(self, system_ip)[source]¶ Provides BFD state for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device BFD state data.
- Return type
result (dict)
-
get_bfd_device_state_tloc
(self, system_ip)[source]¶ Provides BFD state summary with TLOC for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device BFD state summary with TLOC data.
- Return type
result (dict)
-
get_bfd_summary
(self, system_ip)[source]¶ Provides BFD summary data for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device BFD summary data.
- Return type
result (dict)
-
get_bfd_tloc
(self, system_ip)[source]¶ Provides BFD TLOC for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device BFD TLOC data.
- Return type
result (dict)
-
get_bgp_neighbors
(self, system_ip, **kwargs)[source]¶ Provides BGP neighbors for device.
- Parameters
system_ip (str) – Device System IP
vpn-id (str) – VPN ID
peer-addr (str) – Peer address
as (str) – ASN
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_bgp_routes
(self, system_ip, **kwargs)[source]¶ Provides BGP routes for device.
- Parameters
system_ip (str) – Device System IP
vpn-id (str) – VPN ID
prefix (str) – IP prefix
nexthop (str) – Nexthop
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_bgp_summary
(self, system_ip)[source]¶ Provides BGP summary for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_connections
(self, system_ip)[source]¶ Provides celluar connection information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_hardware
(self, system_ip)[source]¶ Provides celluar hardware information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_modems
(self, policy_id)[source]¶ Provides celluar modem information for device.
- Parameters
policy_id (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_networks
(self, system_ip)[source]¶ Provides celluar network information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_profiles
(self, system_ip)[source]¶ Provides celluar profile information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_radios
(self, system_ip)[source]¶ Provides celluar radio information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_sessions
(self, system_ip, **kwargs)[source]¶ Provides celluar session information for device.
- Parameters
system_ip (str) – Device System IP
interface_name (str) – Interface name values: ge0/0 - ge0/7, system, , eth0
primary_dns_ipv4 (str) – Primary DNS IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_cellular_status
(self, system_ip)[source]¶ Provides celluar status information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_affinity_config
(self, system_ip)[source]¶ Provides current control affinity config for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_affinity_status
(self, system_ip)[source]¶ Provides current control affinity status for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_connections
(self, system_ip, **kwargs)[source]¶ Provides current control connections for device.
- Parameters
system_ip (str) – Device System IP
peer_type (str) – Peer type (vedge, vsmart, vmanage, vbond)
peer_system_ip (str) – Peer System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_connections_history
(self, system_ip, **kwargs)[source]¶ Provides control connections history for device.
- Parameters
system_ip (str) – Device System IP
peer_type (str) – Peer type (vedge, vsmart, vmanage, vbond)
peer_system_ip (str) – Peer System IP
local_color (str) – Local Color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_count
(self)[source]¶ Provides current control count for device.
- Parameters
None (None) –
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_links
(self, system_ip, **kwargs)[source]¶ Provides control links for device.
- Parameters
system_ip (str) – Device System IP
state (str) – State
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_local_properties
(self, system_ip)[source]¶ Provides control local properties history for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_summary
(self, system_ip)[source]¶ Provides current control summary for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_valid_devices
(self, system_ip)[source]¶ Provides control valid devices for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_valid_vsmarts
(self, system_ip)[source]¶ Provides control valid vsmarts for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_wan_interface
(self, system_ip)[source]¶ Provides current control wan interface for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_control_wan_interface_color
(self, system_ip)[source]¶ Provides current control wan interface for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_device_status
(self, system_ip)[source]¶ Provides status for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_device_system_info
(self, system_ip)[source]¶ Provides system info for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dhcp_clients
(self, system_ip)[source]¶ Provides dhcp clients for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dhcp_interfaces
(self, system_ip)[source]¶ Provides dhcp interfaces for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dhcp_servers
(self, system_ip)[source]¶ Provides dhcp servers for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dot1x_clients
(self, system_ip)[source]¶ Provides DOT1X clients for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dot1x_interfaces
(self, system_ip)[source]¶ Provides DOT1X interfaces for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dot1x_radius
(self, system_ip)[source]¶ Provides DOT1X RADIUS information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_applications
(self, system_ip, **kwargs)[source]¶ Provides DPI application information for device.
- Parameters
system_ip (str) – Device System IP
vpn_id (str) – VPN/VRF ID
application (str) – Application
family (str) – Family
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_common_applications
(self)[source]¶ Provides common DPI application information.
- Parameters
None (None) – None
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_device_fields
(self)[source]¶ Provides DPI fields for device.
- Parameters
None (None) – None
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_device_fields_details
(self)[source]¶ Provides DPI detailed fields for device.
- Parameters
None (None) – None
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_flows
(self, system_ip, **kwargs)[source]¶ Provides DPI application information for device.
- Parameters
system_ip (str) – Device System IP
vpn_id (str) – VPN/VRF ID
source_ip (str) – Source IP
application (str) – Application
family (str) – Family
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_summary
(self, system_ip)[source]¶ Provides DPI summary information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_dpi_supported_applications
(self, system_ip, **kwargs)[source]¶ Provides DPI supported application information for device.
- Parameters
system_ip (str) – Device System IP
application (str) – Application
family (str) – Family
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_eigrp_interfaces
(self, system_ip)[source]¶ Provides EIGRP interface for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_eigrp_routes
(self, system_ip)[source]¶ Provides EIGRP route for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_eigrp_topology
(self, system_ip)[source]¶ Provides EIGRP topology for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_hardware_alarms
(self, system_ip)[source]¶ Provides hardware alarms for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_hardware_environment
(self, system_ip)[source]¶ Provides hardware environment information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_hardware_inventory
(self, system_ip)[source]¶ Provides hardware inventory information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_hardware_status_summary
(self, system_ip)[source]¶ Provides hardware status summary information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_hardware_system
(self, system_ip)[source]¶ Provides hardware system information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_igmp_groups
(self, system_ip)[source]¶ Provides IGMP groups information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_igmp_interfaces
(self, system_ip)[source]¶ Provides IGMP interfaces information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_igmp_statistics
(self, system_ip)[source]¶ Provides IGMP statistics information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_igmp_summary
(self, system_ip)[source]¶ Provides IGMP summary information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_interface_vpn
(self, system_ip)[source]¶ Provides interface vpn/vrf information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ip_fib
(self, system_ip, **kwargs)[source]¶ Provides IP FIB for device.
- Parameters
system_ip (str) – Device System IP
vpn_id (str) – VPN ID
address_family (str) – Address Family
destination_prefix (str) – Destination Prefix
tloc (str) – TLOC
color (str) – TLOC color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ip_route_table
(self, system_ip, **kwargs)[source]¶ Provides IP route table for device.
- Parameters
system_ip (str) – Device System IP
vpn_id (str) – VPN ID
address_family (str) – Address Family
destination_prefix (str) – Destination Prefix
source_protocol (str) – Source Protocol
next_hop_address (str) – Next-Hop Address (cEdge Only)
next_hop_oif (str) – Next-Hop Outgoing Interface (cEdge Only)
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ip_nat_translations
(self, system_ip)[source]¶ Provides IP NAT translations for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ip_nat64_translations
(self, system_ip)[source]¶ Provides IP NAT64 translations for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ipsec_inbound_connections
(self, system_ip, **kwargs)[source]¶ Provides IPSec inbound connections for device.
- Parameters
system_ip (str) – Device System IP
remote_tloc_address (str) – Remote TLOC address
remote_tloc_color (str) – Remote TLOC color
local_tloc_color (str) – Local TLOC color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ipsec_localsa
(self, system_ip)[source]¶ Provides IPSec localsa for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ipsec_outbound_connections
(self, system_ip, **kwargs)[source]¶ Provides IPSec outbound connections for device.
- Parameters
system_ip (str) – Device System IP
remote_tloc_address (str) – Remote TLOC address
remote_tloc_color (str) – Remote TLOC color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ipsec_pwk_inbound_connections
(self, system_ip, **kwargs)[source]¶ Provides IPSec pairwise key inbound connections for device.
- Parameters
system_ip (str) – Device System IP
remote_tloc_address (str) – Remote TLOC address
remote_tloc_color (str) – Remote TLOC color
local_tloc_color (str) – Local TLOC color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ipsec_pwk_localsa
(self, system_ip, **kwargs)[source]¶ Provides IPSec pairwise key localsa for device.
- Parameters
system_ip (str) – Device System IP
remote_tloc_address (str) – Remote TLOC address
remote_tloc_color (str) – Remote TLOC color
local_tloc_color (str) – Local TLOC color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ipsec_pwk_outbound_connections
(self, system_ip, **kwargs)[source]¶ Provides IPSec pairwise key outbound connections for device.
- Parameters
system_ip (str) – Device System IP
remote_tloc_address (str) – Remote TLOC address
remote_tloc_color (str) – Remote TLOC color
local_tloc_color (str) – Local TLOC color
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_multicast_replicator
(self, system_ip)[source]¶ Provides multicast replicator for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_multicast_rpf
(self, system_ip)[source]¶ Provides multicast rpf for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_multicast_topology
(self, system_ip)[source]¶ Provides multicast topology for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_multicast_tunnel
(self, system_ip)[source]¶ Provides multicast tunnel for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_omp_peers
(self, system_ip)[source]¶ Provides OMP peers for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_omp_routes_received
(self, system_ip, **kwargs)[source]¶ Provides OMP received routes for device.
- Parameters
system_ip (str) – Device System IP
vpn_id (str) – VPN ID
prefix (str) – Prefix
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_omp_routes_advertised
(self, system_ip, **kwargs)[source]¶ Provides OMP advertised routes for device.
- Parameters
system_ip (str) – Device System IP
vpn_id (str) – VPN ID
prefix (str) – Prefix
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_omp_summary
(self, system_ip)[source]¶ Provides OMP summary for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_orchestrator_summary
(self, system_ip)[source]¶ Provides orchestrator (vbond) summary for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_orchestrator_connections
(self, system_ip)[source]¶ Provides orchestrator (vbond) connections for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_orchestrator_connections_history
(self, system_ip)[source]¶ Provides orchestrator (vbond) connections history for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_orchestrator_local_properties
(self, system_ip)[source]¶ Provides orchestrator (vbond) local properties history for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_interfaces
(self, system_ip)[source]¶ Provides OSPF interfaces for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_neighbors
(self, system_ip)[source]¶ Provides OSPF neighbors for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_routes
(self, system_ip)[source]¶ Provides OSPF routes for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_database
(self, system_ip)[source]¶ Provides OSPF database for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_database_summary
(self, system_ip)[source]¶ Provides OSPF database summary for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_process
(self, system_ip)[source]¶ Provides OSPF process for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_ospf_database_external
(self, system_ip)[source]¶ Provides OSPF database external for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_pim_interfaces
(self, system_ip)[source]¶ Provides PIM interfaces for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_pim_neighbors
(self, system_ip)[source]¶ Provides PIM neighbors for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_pim_rp_mapping
(self, system_ip)[source]¶ Provides PIM RP mapping for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_pim_statistics
(self, system_ip)[source]¶ Provides PIM statistics for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_security_information
(self, system_ip)[source]¶ Provides security information for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_software
(self, system_ip)[source]¶ Provides software for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_umbrella_sig_tunnels
(self, system_ip)[source]¶ Provides Cisco Umbrella SIG tunnels for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_users
(self, system_ip)[source]¶ Provides users for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device ARP table data.
- Return type
result (dict)
-
get_users_list
(self, system_ip)[source]¶ Provides users list for device.
- Parameters
system_ip (str) – Device System IP
- Returns
Device ARP table data.
- Return type
result (dict)
-
get_vrrp
(self, system_ip)[source]¶ Provides VRRP entries for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_wlan_clients
(self, system_ip)[source]¶ Provides WLAN clients for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_wlan_interfaces
(self, system_ip)[source]¶ Provides WLAN interfaces for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-
get_wlan_radios
(self, system_ip)[source]¶ Provides WLAN radios for device.
- Parameters
system_ip (str) – Device System IP
- Returns
All data associated with a response.
- Return type
result (dict)
-