- Classes
- API Functions
- class BGPSession( ASN=None, vrf=‘default’)
- class BGPNeighbor( ip_address , vrf = ‘default’ , **kwargs)
- class BufferDepthMonitor()
- class CLI(command=‘’, do_print=TRUE)
- class CheckPortDiscards(port)
- class CiscoSecret(key, type=0)
- class CiscoSocket([ family [, type [, proto ]]])
- class FTPTransfer( source , dest =‘’ , host =(None, None) , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’)
- class Feature(__builtin__.object)
- class HTTPTransfer( source , dest =‘’, host =(None, None) , vrf =‘management’ , login_timeout =10)
- class History()
- class IPv4ACL( name)
- class IPv6ACL( name)
- class Interface( intf)
- class Key( key =‘’ , start =‘’ , end=‘’)
- class MacAddressTable()
- class PasswordProtoTransfer( source , dest =‘’ , host=(None, None) , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’)
- class RouteMap( name , sequence , type =‘permit’)
- class Routes()
- class SCPTransfer( source , dest =‘’ , host =(None, None) , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’)
- class SFTPTransfer( source , dest=‘’ , host =(None, None) , vrf =‘management’ , login_timeout =10 , user =‘’ , password=‘’)
- class SSH()
- class ShowInterface( ifname)
- class System(__builtin__.object)
- class TFTPTransfer( source , dest =‘’ , host =(None, None) , vrf =‘management’ , login_timeout =10)
- class Tacacs()
- class Transfer( source , dest =‘’ , host =(None, None) , vrf =‘management’ , login_timeout =10)
- class VRF( vrf)
- class Vlan()
- class bfd( Feature)
- class dhcp( Feature)
- class eigrp( Feature)
- class hsrp( Feature)
- class interface-vlan( Feature)
- class lacp( Feature)
- class msdp( Feature)
- class ospf( Feature)
- class ospfv3( Feature)
- class pim( Feature)
- class private-vlan( Feature)
- class ptp( Feature)
- class rip( Feature)
- class scheduler( Feature)
- class telnet( Feature)
- class udld( Feature)
- class vpc( Feature)
- class vrrp( Feature)
- class vtp( Feature)
API Functions
This chapter provides information about Python application programming interface (API) functions and includes the following sections:
API Functions
class BGPSession( ASN =None, vrf =‘default’)
Use this class to configure the BGP feature.
add_network( network , ** kwargs )
Configure an IP prefix to advertise. To remove the IP prefix to advertise, set the optional no argument to TRUE .
Arguments
network : A string representing the IP prefix in either Classless Inter-Domain Routing (CIDR) notation or dotted quad. For example, ‘192.0.2.0/24’ or ‘192.0.2.0/255.255.255.0’.
Usage Guidelines
The IP prefix to advertise is considered for bestpath purposes and advertisement to peers only if a route of equal or more specificity is present in the routing table.
cfg_aggregate_address( address , ** kwargs )
Create a summary address in a Border Gateway Protocol (BGP) routing table. To remove the summary address, set the optional no argument to TRUE .
Arguments
address : A string representing the aggregate IP address and mask in either CIDR notation or dotted quad. For example, ‘192.0.2.0/24’ or ‘192.0.2.0/255.255.255.0’.
Optional Arguments
advertise_map : A string that specifies the name of the route map used to select attribute information from specific routes. Should be an alphanumeric string up to 63 characters long.
as_set : A Boolean. Set to TRUE to generate the autonomous system set path information and community information from the contributing paths.
attribute_map : A string that specifies the name of the route map used to set the attribute information for specific routes. Should be an alphanumeric string up to 63 characters long.
summary_only : A Boolean. Set to TRUE to filter all more specific routes from updates.
suppress_map : A string that specifies the name of the route map used to conditionally filter more specific routes. Should be an alphanumeric string up to 63 characters.
Optional Arguments
always_compare_med : A Boolean. Set to TRUE to compare the Multi-Exit Discriminator (MED) on paths from a different autonomous system (AS). Set to FALSE to remove this configuration.
as_path_multipath_relax : A Boolean. Set to TRUE to configure a BGP routing process to consider the different AS paths and load-balance multiple paths during best-path route selection. Set to FALSE to remove this configuration.
compare_router_id : A Boolean. Set to TRUE to configure a Border Gateway Protocol (BGP) routing process to compare identical routes received from different external peers during the best-path selection process and to select the route with the lowest router ID as the best-path. Set to FALSE to remove this configuration.
med_missing_as_worst : A Boolean. Set to TRUE to assign the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable. Set to FALSE to remove this configuration.
med_non_deterministic : A Boolean. Set to TRUE to specify that the best-MED-path among paths is not picked from the same AS. Set to FALSE to remove this configuration.
Returns
cfg_cli_event_history(** kwargs )
Enable the CLI event history to be saved in a buffer. It is enabled by default. The default buffer size is ‘small’. Possible sizes are ‘small’, ‘medium’, and ‘large’.
Optional Arguments
size : A string. Possible values are: ‘small’, ‘medium’, ‘large’, or ‘disable’.
no : A Boolean. Set to TRUE to stop saving the CLI event history.
Returns
cfg_cluster_id( cluster_id , ** kwargs )
Set the cluster ID on a route reflector in a route reflector cluster. To remove the cluster ID, set the optional no argument to TRUE .
Arguments
cluster_id : Cluster ID of this router acting as a route reflector. Can be specified as an integer ranging from 1 to 4294967295 or as a string in dotted format: ‘A.B.C.D’.
Returns
cfg_confederation_identifier( id , ** kwargs )
Specify a BGP confederation identifier. To remove the confederation identifier, set the optional no argument to TRUE .
Arguments
id : The AS number. Can be specified as an integer ranging from 1 to 4294967295 or as a string in the following format: <1-65535>[.<0-65535>].
Usage Guidelines
The BGP confederation identifier is used to configure a single AS number to identify a group of smaller ASes as a single confederation.
A confederation can be used to reduce the internal BGP (iBGP) mesh by dividing a large single AS into multiple subASes and then grouping them into a single confederation. The subASes within the confederation exchange routing information like iBGP peers. External peers interact with the confederation as if it were a single AS.
Each subAS is fully meshed within itself and has a few connections to other ASes within the confederation. Next-hop, MED, and local preference information is preserved throughout the confederation, allowing you to retain a single Interior Gateway Protocol (IGP) for all ASes.
cfg_confederation_peers( peers , ** kwargs )
Configures subASes to belong to a single confederation. To remove an AS from the confederation, set the optional no argument to TRUE .
Arguments
peers : A string of space-separated AS numbers where each ASN=<1-4294967295>|<1-65535>[.<0-65535>] .
Optional Arguments
no : A Boolean. Set to TRUE to remove the specified AS numbers from the list of confederation peers.
Usage Guidelines
The bgp confederation peers command is used to configure multiple ASes as a single confederation. The ellipsis (...) in the command syntax indicates that your command input can include multiple values for the as-number argument.
The ASes specified in this command are visible internally to the confederation. Each AS is fully meshed within itself. The bgp confederation identifier command specifies the confederation to which the ASes belong.
Enable BGP route dampening or change various BGP route dampening factors. To disable the function, set the optional no argument to TRUE .
Optional Arguments
half_life : Time (in minutes) after which a penalty is decreased. Once the route has been assigned a penalty, the penalty is decreased by half after the half-life period (which is 15 minutes by default). The process of reducing the penalty happens every 5 seconds. The range of the half-life period is 1 to 45 minutes. The default is 15 minutes.
reuse_limit : Value to start reusing a route. The range is from 1 to 20000.
suppress_limit : Value to start suppressing a route. The range is from 1 to 20000.
max_suppress_time : Maximum suppress time for a stable route. The range is from 1 to 255.
route_map : Name of a route map that specifies dampening criteria. The name can be any alphanumeric string up to 63 characters.
Usage Guidelines
You can configure route dampening to minimize route flaps propagating through your iBGP network.
cfg_distance( ebgp_dist , ibgp_dist , local_dist , ** kwargs )
Configure administrative distance for external BGP, internal BGP, and local routes. Default values are: eBGP 20, iBGP 200, and local 220. To set the distances back to the default, set the optional no argument to TRUE .
Arguments
ebgp_dist : Distance for eBGP routes. An integer ranging from 1 to 255.
ibgp_dist : Distance for iBGP routes. An integer ranging from 1 to 255.
local_dist : Distance for local routes. An integer ranging from 1 to 255.
Returns
cfg_events_event_history(** kwargs )
Enable the event history to be saved in a buffer. It is enabled by default. The default buffer size is ‘small’. Possible sizes are ‘small’, ‘medium’, and ‘large’.
Optional Arguments
size : A string. Possible values are: ‘small’, ‘medium’, ‘large’, or ‘disable’.
no : A Boolean. Set to TRUE to stop saving the event history.
Returns
cfg_graceful_restart_restart_time( time , ** kwargs )
Configure the maximum time for restart that is advertised to peers. Default value is 120 seconds. To remove a previously configured value, set the optional no argument to TRUE .
Optional Arguments
no : A Boolean. Set to TRUE to delete the existing configuration and revert to the default.
Returns
cfg_graceful_restart_stalepath_time( time , ** kwargs )
Configure the maximum time to keep a restarting peer’s stale routes. Default value is 300 seconds. To remove a previously configured value, set the optional no argument to TRUE .
Optional Arguments
no : A Boolean. Set to TRUE to delete the existing configuration and revert to the default.
Returns
cfg_ibgp_maximum_paths( max , ** kwargs )
Configure the maximum number of parallel routes that the iBGP can support. To restore the default number of parallel routes, set the optional no argument to TRUE .
Arguments
max : Maximum number of parallel routes that an IP routing protocol installs in a routing table. The range is from 1 to 64.
Returns
cfg_maximum_paths( max , ** kwargs )
Configure the maximum number of parallel routes that the BGP can support. To restore the default number of parallel routes, set the optional no argument to TRUE .
Arguments
max : Maximum number of parallel routes that an IP routing protocol installs in a routing table. The range is from 1 to 64.
Returns
cfg_nexthop_routemap( route_map , ** kwargs )
Specify that BGP routes are resolved using only next-hops whose routes match specific characteristics. To remove the route map, set the optional no argument to TRUE .
Usage Guidelines
Use this function to configure route policy filtering for next-hops. BGP next-hop filtering allows you to specify that when a next-hop address is checked with the Routing Information Base (RIB), the underlying route for that next-hop address is passed through the route map. If the route map rejects the route, the next-hop address is treated as unreachable. BGP marks all next-hops that are rejected by the route policy as invalid and does not calculate the best-path for the routes that use the invalid next-hop address.
cfg_nexthop_trigger_delay( critical_delay =3000 , non_critical_delay =10000 , ** kwargs )
Configure BGP to delay for triggering next-hop calculations. To set the trigger delay to the default value, set the optional no argument to TRUE .
Arguments
critical_delay : An integer specifying the critical next-hop trigger delay in milliseconds. The range is from 1 to 4294967295. The default is 3000.
non_critical_delay : An integer specifying the noncritical next-hop trigger delay in milliseconds. The range is from 1 to 4294967295. The default is 10000.
Usage Guidelines
Use this function to modify when BGP processes next-hop address tracking events. The non-critical delay value must always be equal to or greater than the critical delay value. The delay should be slightly higher than the time it takes for the Interior Gateway Protocol (IGP) to settle into a steady state after some event (IGP convergence time).
cfg_periodic_event_history(** kwargs )
Enable periodic event history to be saved in a buffer. It is enabled by default. The default buffer size is ‘small’. Possible sizes are ‘small’, ‘medium’, and ‘large’.
Optional Arguments
size : A string. Possible values are: ‘small’, ‘medium’, ‘large’, or ‘disable’.
no : A Boolean. Set to TRUE to stop saving the periodic event history.
Returns
cfg_router_id( router_id , ** kwargs )
Specify the IP address to use as the router ID. To remove this configuration, set the optional no argument to TRUE .
Arguments
router_id : A string in dotted quad format (‘A.B.C.D’) representing the IP address of the router.
Returns
client_to_client_route_reflection(** kwargs )
Configure client-to-client route reflection. This feature is enabled by default. This command triggers an automatic soft-clear or refresh of BGP neighbor sessions. To disable this feature, set the optional no argument to TRUE .
Returns
Configure a router to deny an update received from an external BGP (eBGP) peer that does not list its AS number at the beginning of the AS_PATH in the incoming update. To disable this behavior, set the optional no argument to TRUE .
Usage Guidelines
The bgp enforce-first-as command is used to deny incoming updates received from eBGP peers that do not list their AS number as the first segment in the AS_PATH attribute. Enabling this command prevents a misconfigured or unauthorized peer from misdirecting traffic (spoofing the local router) by advertising a route as if it were sourced from another AS.
fast_external_fallover(** kwargs )
Configure the BGP process to immediately reset the session if the link to a directly connected BGP peer goes down. This is enabled by default. To disable this behavior, set the optional no argument to TRUE .
Returns
Flush routes in the RIB upon a controlled restart. To disable this behavior, set the optional no argument to TRUE .
Returns
Enable graceful restart and graceful restart helper functionality. This is enabled by default. To disable this behavior, set the optional no argument to TRUE .
Usage Guidelines
The graceful-restart command is used to configure or disable the graceful restart capability on a router in a BGP network. If the graceful restart capability is enabled after a BGP session has been established, you need to restart the session with a soft or hard reset.
The default timer values for this feature are optimal for most network deployments. We recommend that they are adjusted only by experienced network operators. When adjusting the timer values, the restart timer should not be set to a value greater than the hold time that is carried in the OPEN message. If consecutive restart operations occur, routes (from a restarting router) that were previously marked as stale are deleted.
graceful_restart_helper(** kwargs )
Configure graceful restart helper mode functionality. To disable this behavior, set the optional no argument to TRUE .
Usage Guidelines
The graceful-restart-helper command is used to configure the local BGP router to support the graceful restart of a remote BGP peer.
Returns
TRUE if the BGP process is enabled and shut down.
FALSE if the BGP process is running or if BGP is not enabled.
log_neighbor_changes(** kwargs )
Log a message for a neighbor up/down event. To disable this behavior, set the optional no argument to TRUE .
Returns
max_as_limit( limit , ** kwargs )
Allow the AS_PATH attribute from an eBGP neighbor, imposing a limit on the number of ASes. To disable this behavior, set the optional no argument to TRUE .
Arguments
limit : An integer ranging from 1 to 512 representing the number of ASes in the AS_PATH attribute.
Returns
redistribute_direct_routes( route_map , ** kwargs )
Inject routes that are directly connected on an interface into the BGP. To restore the system to its default condition in which the software does not redistribute routes, set the optional no argument to TRUE .
Arguments
route_map : An alphanumeric string up to 63 characters specifying the identifier of a configured route map. Use a route map to filter which routes are redistributed into BGP.
Returns
redistribute_eigrp_routes( instance_tag , route_map , ** kwargs )
Inject routes from the Enhanced Interior Gateway Routing Protocol (EIGRP) into the BGP. To restore the system to its default condition in which the software does not redistribute routes, set the optional no argument to TRUE .
Arguments
instance_tag : Any case-sensitive, alphanumeric string up to 64 characters.
route_map : Specifies the identifier of a configured route map. Use a route map to filter which routes are redistributed into BGP.
Returns
redistribute_isis_routes( instance_tag , route_map , ** kwargs )
Inject routes from the Intermediate System to Intermediate System (IS-IS) protocol into the BGP. To restore the system to its default condition in which the software does not redistribute routes, set the optional no argument to TRUE .
Arguments
instance_tag : Any case-sensitive, alphanumeric string up to 64 characters.
route_map : Specifies the identifier of a configured route map. Use a route map to filter which routes are redistributed into BGP.
Returns
redistribute_ospf_routes( protocol_tag , route_map , ** kwargs )
Inject routes from the Open Shortest Path First (OSPF) protocol into the BGP. To restore the system to its default condition in which the software does not redistribute routes, set the optional no argument to TRUE .
Arguments
protocol_tag : Any case-sensitive, alphanumeric string up to 64 characters.
route_map : Specifies the identifier of a configured route map. Use a route map to filter which routes are redistributed into BGP.
Returns
redistribute_rip_routes( instance_tag , route_map , ** kwargs )
Inject routes from the Routing Information Protocol (RIP) protocol into the BGP. To restore the system to its default condition in which the software does not redistribute routes, set the optional no argument to TRUE .
Arguments
instance_tag : Any case-sensitive, alphanumeric string up to 64 characters.
route_map : Specifies the identifier of a configured route map. Use a route map to filter which routes are redistributed into BGP.
Returns
redistribute_static_routes( route_map , ** kwargs )
Inject static routes into the BGP. To restore the system to its default condition in which the software does not redistribute routes, set the optional no argument to TRUE .
Arguments
route_map : Specifies the identifier of a configured route map. Use a route map to filter which routes are redistributed into BGP.
Returns
set_addr_family( ip_version , transmission_type )
Enable an address family for use with BGP. Possible address families are ipv4 unicast, ipv4 multicast, ipv6 unicast, and ipv6 multicast. This function sets the current address-family for use with functions that configure address-family attributes.
Arguments
ip_version : A string. Possible values are ‘ipv4’ and ‘ipv6’.
transmission_type : A string. Possible values are ‘unicast’ and ‘multicast’.
Returns
ValueError if an invalid ip_version or transmission_type is specified.
set_default_metric( metric , ** kwargs )
Set the metric of redistributed routes. To remove this configuration, set the optional no argument to TRUE .
Returns
Set the VRF (Virtual Routing and Forwarding) context for subsequent API calls on this BGPSession object. Any configuration done on this BGPSession object is applied to this VRF.
Returns
Start the BGP routing process. If BGP is shut down, this restarts it. If the BGP feature is disabled, this enables the feature in addition to starting the process.
Returns
Configure the BGP process to advertise active routes to a BGP peer only. To remove the restriction, set the optional no argument to TRUE .
Returns
----------------------------------------------------------------------
----------------------------------------------------------------------
Data and other attributes defined here:
BGPNeighbor = <class ‘cisco.BGPNeighbor’>
Use this class to configure a BGP neighbor.
----------------------------------------------------------------------
Returns
TRUE if the feature is enabled.
Feature name—as used in the configure terminal command.
Feature name—as seen in the show feature command.
Return the state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
__new__( typ , * args , ** kwargs )
Create a single instance of an object per each derived class.
class BGPNeighbor( ip_address , vrf= ‘default’, **kwargs)
Use this class to configure a BGP neighbor. This class is an attribute of the BGPSession class.
Add a BGP neighbor to the BGP configuration.
Returns
Configure BGP to accept AS paths with this neighbor’s AS present.
To remove this configuration, set the optional no argument to TRUE .
Optional Arguments
num_occurrences : Number of occurrences of AS number., an integer ranging from 1 to 10.
Returns
cfg_advertise_map( map , ** kwargs )
Configure Border Gateway Protocol (BGP) conditional advertisement. To remove a BGP conditional advertisement, set the optional no argument to TRUE .
Arguments
map : Route map with match statements that the route must pass before BGP passes the route to the next route map. The map is a case-sensitive, alphanumeric string up to 63 characters.
Optional Arguments
exist_map : Specifies a route map with match statements for a prefix list. A prefix in the BGP table must match a prefix in the prefix list before BGP advertises the route. exist_map is a case-sensitive, alphanumeric string up to 63 characters.
non_exist_map : Specifies a route map without match statements for a prefix list. A prefix in the BGP table must not match a prefix in the prefix list before BGP advertises the route. non_exist_map is a case-sensitive, alphanumeric string up to 63 characters.
no : A Boolean. Set to TRUE to remove a BGP conditional advertisement.
Returns
cfg_ebgp_multihop( ebgp_ttl =None , ** kwargs )
Accepts and attempts BGP connections to external peers that reside on networks that are not directly connected.
Returns
cfg_filter_list_in( filter , ** kwargs )
Apply the AS_PATH filter list to incoming routes. To remove this configuration, set the optional no argument to TRUE .
Returns
cfg_filter_list_out( filter , ** kwargs )
Apply AS_PATH filter list to outgoing routes. To remove this configuration, set the optional no argument to TRUE .
Returns
cfg_local_as( ASN =None , ** kwargs )
Configure a router to appear as a member of a second AS in addition to the real AS of the device. To remove the local AS configuration, set the optional no argument to TRUE .
Arguments
ASN : A string or integer representing the Autonomous System Number. If an integer, range is from 1 to 4294967295. If a string, it should be in this format <1-4294967295>|<1-65535>[.<0-65535>].
Optional Arguments
no_prepend : A Boolean. Set to TRUE to prevent prepending the local AS number to any routes received from the eBGP neighbor.
replace_as : A Boolean. Set to TRUE to prepend only the local AS number to updates to the eBGP neighbor.
dual_as : A Boolean. Set to TRUE to configure the eBGP neighbor to establish a peering session using the real ASN (from the local BGP routing process) or by using the ASN.
no : A Boolean. Set to TRUE to remove the local AS configuration.
Returns
cfg_maximum_prefix( limit =None , ** kwargs )
Configure the maximum number of prefixes from this neighbor. To remove this configuration, set the optional no argument to TRUE.
Optional Arguments
threshold : Threshold percentage at which to generate a warning. An integer ranging from 1 to 100.
restart_interval : Restart the BGP connection after the limit is exceeded. An integer ranging from 1 to 65535.
warning_only : A Boolean. Set to TRUE to only give a warning message when the limit is exceeded.
Returns
cfg_password( password =None , ** kwargs )
Configure a password for this BGP neighbor. To remove a password, set the optional no argument to TRUE .
Returns
cfg_prefix_list_in( list , ** kwargs )
Apply a prefix-list to incoming routes. Set the optional no argument to TRUE to remove this configuration.
Returns
cfg_prefix_list_out( list , ** kwargs )
Apply a prefix-list to outgoing routes. Set the optional no argument to TRUE to remove this configuration.
Returns
cfg_remote_as( ASN =None , ** kwargs )
Specify the AS number for this neighbor. To remove an AS number set the optional no argument to TRUE .
Arguments
ASN : A string or integer representing the ASN. If integer, range is from 1 to 4294967295. If string, it should be in this format: ‘<1-4294967295>|<1-65535>[.<0-65535>]’.
Returns
cfg_route_map_in( map , ** kwargs )
Apply a route-map to incoming routes. Set the optional no argument to TRUE to remove this configuration.
Returns
cfg_route_map_out( map , ** kwargs )
Apply a route-map to outgoing routes. Set the optional no argument to TRUE to remove this configuration.
Returns
cfg_timers( keepalive_interval =60 , holdtime =180 , ** kwargs )
Configure keepalive and hold timers in seconds. Default values are 60 seconds for keepalive and 180 seconds for hold time. To set back to the default values, set the optional no argument to TRUE .
Returns
cfg_update_source( interface =None , ** kwargs )
Specify the source of the BGP session and updates. The Cisco NX-OS software allows BGP sessions to use any operational interface for TCP connections. To restore the interface assignment to the closest interface, which is called the best local address, set the optional no argument to TRUE .
Arguments
interface : A string representing an interface on the switch. Can be Ethernet, loopback, port-channel or a VLAN in either expanded or short forms. For example, ‘e1/1.2’, ‘Ethernet1/1.2’.
Optional Arguments
no : A Boolean. Set to TRUE to restore the interface assignment to the best local address.
Returns
Originate a default toward this neighbor. To remove this configuration, set the optional no argument to TRUE .
Optional Arguments
route_map : Name of route-map that specifies criteria for the originating default.
Returns
disable_connected_check(** kwargs )
Disable the connection verification for the directly connected peer.
Optional Arguments
no : A Boolean. Set to TRUE to enable the connection verification for the directly connected peer.
Usage Guidelines
Use this function to disable a check for an eBGP peer that is directly connected to the local router. BGP triggers a connection check automatically for all eBGP peers that are known to be a single hop away, unless you disable this check with this function. BGP does not bring up sessions if the check fails. BGP considers an eBGP peer as a single hop away if the eBGP peer does not have the ebgp-multihop option configured (that is, the time-to-live (TTL) value is one).
Optional Arguments
no : A Boolean. Set to TRUE to turn on the negotiate capability with this neighbor.
Returns
TRUE if this BGP neighbor exists.
FALSE if this BGP neighbor does not exist.
Exempt this BGP neighbor from a low-memory shutdown. To make this BGP neighbor eligible for a low-memory shutdown, set the optional no argument to TRUE .
Optional Arguments
no : A Boolean. Set to TRUE to make this BGP neighbor eligible for a low-memory shutdown.
Returns
Set our peering address as nexthop. To remove this configuration, set the optional no argument to TRUE .
Returns
next_hop_third_party(** kwargs )
Compute a third-party nexthop if possible. To remove this configuration, set the optional no argument to TRUE .
Returns
ValueError if the neighbor does not exist.
Remove the private AS number from outbound updates. To include the private AS number in outbound updates, set the optional no argument to TRUE .
Optional Arguments
no : A Boolean. Set to TRUE to include the private AS number in outbound updates.
Returns
route_reflector_client(** kwargs )
Configure this neighbor as a route reflector client. To remove this configuration, set the optional no argument to TRUE .
Returns
Send the BGP community attribute to this neighbor. To revert back to the defaults, set the optional no argument to TRUE .
Returns
send_community_extended(** kwargs )
Send the BGP extended community attribute to this neighbor. To revert back to the defaults, set the optional no argument to TRUE .
Returns
set_addr_family( ip_version , transmission_type )
Returns
Administratively shut down this neighbor. All existing configurations are preserved. To enable this neighbor, set the optional no argument to TRUE .
Returns
soft_reconfiguration_inbound(** kwargs )
Configure the switch software to start storing BGP peer updates. To not store received updates, set the optional no argument to TRUE .
Usage Guidelines
Entering this command starts the storage of updates, which is required to do inbound soft reconfiguration. To use soft reconfiguration, or soft reset, without preconfiguration, both BGP peers must support the soft route refresh capability.
Advertise the active routes to a BGP peer only. To remove the restriction, set the optional no argument to TRUE .
class BufferDepthMonitor()
----------------------------------------------------------------------
get_xml_dom_from_cli_output( text )
key_value_colon_parser( line )
key_value_xml_parser( element )
----------------------------------------------------------------------
Data descriptors inherited from CLI :
class CLI( command =‘’, do_print =TRUE)
Generic CLI base class with useful utilities.
get_xml_dom_from_cli_output( text )
key_value_colon_parser( line )
key_value_xml_parser( element )
----------------------------------------------------------------------
Data descriptors defined here:
class CheckPortDiscards( port )
---------------------------------------------------------------------
get_xml_dom_from_cli_output( text )
key_value_colon_parser( line )
key_value_xml_parser( element )
----------------------------------------------------------------------
Data descriptors inherited from CLI :
class CiscoSecret( key , type =0)
Cisco password container keytype:
5—encrypted (stronger, not all CLIs support it).
----------------------------------------------------------------------
Data descriptors defined here:
class CiscoSocket([ family [, type [, proto ]]])
Extend the socket.socket class in order to provide a way to set/get the Virtual Routing and Forwarding (VRF) associated with a socket. The default VRF for a CiscoSocket is ‘management’ (2).
Get the VRF associated with a CiscoSocket .
Example
----------------------------------------------------------------------
Data descriptors defined here:
Dictionary for instance variables (if defined).
----------------------------------------------------------------------
Methods inherited from socket._socketobject :
accept() -> (socket object, address info)
Wait for an incoming connection. Return a new socket representing the connection and the address of the client. For IP sockets, the address info is a pair ( hostaddr , port ).
Bind the socket to a local address. For IP sockets, the address is a pair ( host , port ); the host must refer to the local host. For raw packet sockets, the address is a tuple ( ifname , proto [, pkttype [, hatype ]]) .
close( _closedsocket =<class ‘socket._closedsocket’> , _delegate_methods =(‘recv’, ‘recvfrom’, ‘recv_into’, ‘recvfrom_into’, ‘send’, ‘sendto’) , setattr =<built-in function setattr>)
Close the socket. It cannot be used after this call.
Connect the socket to a remote address. For IP sockets, the address is a pair ( host , port ).
connect_ex( address ) -> errno
This is like connect( address ) , but returns an error code (the errno value) instead of raising an exception when an error occurs.
Return a new socket object connected to the same system resource.
Return the integer file descriptor of the socket.
Return the address of the remote endpoint. For IP sockets, the address info is a pair ( hostaddr , port ).
Return the address of the local endpoint. For IP sockets, the address info is a pair ( hostaddr , port ).
getsockopt( level , option [, buffersize ]) -> value
Get a socket option. See the Unix manual for level and option . If a nonzero buffersize argument is given, the return value is a string of that length; otherwise it is an integer.
Return the timeout in floating seconds associated with socket operations. A timeout of None indicates that timeouts on socket operations are disabled.
Enable a server to accept connections. The backlog argument must be at least 0 (if it is lower, it is set to 0); it specifies the number of unaccepted connections that the system allows before refusing new connections.
makefile( mode ='r' , bufsize =-1 )
makefile([ mode [, bufsize ]]) -> file object
Return a regular file object corresponding to the socket. The mode and bufsize arguments are as for the built-in open() function.
Send a data string to the socket. For the optional flags argument, see the Unix manual. This function calls send() repeatedly until all data is sent. If an error occurs, it is impossible to tell how much data has been sent.
Set the socket to blocking ( flag is TRUE ) or non-blocking ( FALSE ). setblocking(TRUE ) is equivalent to settimeout(None) ; setblocking(FALSE) is equivalent to settimeout(0.0) .
setsockopt( level , option , value )
Set a socket option. See the Unix manual for level and option . The value argument can either be an integer or a string.
Set a timeout on socket operations. timeout can be a float, giving in seconds, or None . Setting a timeout of None disables the timeout feature and is equivalent to setblocking(1) . Setting a timeout of zero is the same as setblocking(0) .
Shut down the reading side of the socket ( flag == SHUT_RD ), the writing side of the socket ( flag == SHUT_WR ), or both ends ( flag == SHUT_RDWR ).
----------------------------------------------------------------------
Data descriptors inherited from socket._socketobject :
class FTPTransfer( source , dest =‘’, host =(None, None), vrf =‘management’, login_timeout =10, user =‘’, password =‘’)
----------------------------------------------------------------------
Methods inherited from PasswordProtoTransfer :
setusercredentials( user , password )
----------------------------------------------------------------------
Methods inherited from Transfer :
find_local_filename( filename =‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
----------------------------------------------------------------------
Static methods inherited from Transfer :
gettransferobj( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash:’ , vrf =‘management’ , login_timeout =10 , user = ‘’ , password =‘’ )
----------------------------------------------------------------------
Data descriptors inherited from Transfer :
class Feature(__builtin__.object)
An abstract base class for Nexus OS Features. It has one get() class method that returns a singleton object per feature.
Arguments to cisco.Feature.get() can be one of the following strings:
If called multiple times with the same feature name, cisco.feature.get() returns the same object.
class HTTPTransfer( source , dest =‘’, host =(None, None), vrf =‘management’, login_timeout =10)
----------------------------------------------------------------------
Methods inherited from Transfer :
find_local_filename( filename =‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
----------------------------------------------------------------------
Static methods inherited from Transfer :
gettransferobj( protoco =‘’ , host =‘’ , source =‘’ , dest =‘bootflash:’ , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
----------------------------------------------------------------------
Data descriptors inherited from Transfer :
class History()
----------------------------------------------------------------------
----------------------------------------------------------------------
Data descriptors defined here:
Dictionary for instance variables (if defined).
List of weak references to the object (if defined).
----------------------------------------------------------------------
Data and other attributes defined here:
----------------------------------------------------------------------
Methods inherited from __builtin__.dict :
D.__contains__(k) -> TRUE if D has a key k, else FALSE .
x.__delitem__(y) <==> del x[y]
x.__getattribute__(‘name’) <==> x.name
x.__setitem__(i, y) <==> x[i]=y
D.__sizeof__() -> size of D in memory, in bytes.
D.copy() -> a shallow copy of D.
D.get( k [, d ]) -> D[ k ] if k in D, else d . d defaults to None .
D.has_key( k ) -> TRUE if D has a key k , else FALSE .
D.items() -> list of D’s ( key , value ) pairs, as 2-tuples.
D.iteritems() -> an iterator over the ( key , value ) items of D .
D.iterkeys() -> an iterator over the keys of D .
D.itervalues() -> an iterator over the values of D .
D.keys() -> list of D ’s keys.
Remove specified key and return the corresponding value. If key is not found, d is returned, if given. Otherwise, KeyError is raised.
Remove and return some ( key , value ) pair as a 2-tuple; but raise KeyError if D is empty.
D.setdefault( k [, d ]) -> D.get( k , d ), also set D[ k ]= d if k not in D .
D.update( E , ** F ) -> None .
Update D from dict/iterable E and F . If E has a .keys() method, this function does: for k in E : D[ k ]= E [ k ] . If E lacks .keys() method, this function does: for ( k , v ) in E : D[ k ] = v . In either case, this is followed by: for k in F : D[ k ] = F [ k ] .
D.values() -> list of D’s values.
D.viewitems() -> a set-like object providing a view on D’s items.
D.viewkeys() -> a set-like object providing a view on D’s keys.
D.viewvalues() -> an object providing a view on D’s values.
----------------------------------------------------------------------
Data and other attributes inherited from __builtin__.dict :
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys( S [, v ]) -> New dict with keys from S and values equal to v . v defaults to None .
class IPv4ACL( name )
Use this class to configure the IPv4 ACL .
deny( protocol , source , destination , ** kwargs )
Specify packets to reject. To stop rejecting particular packet types, set the optional no argument to TRUE .
Arguments
protocol : An integer ranging from <0-255> representing the protocol number, or a string representing the protocol name.
source : A string representing the source IP address or network in either CIDR notation or dotted quad. For example, ‘192.0.2.0’, ‘192.0.2.0/24’, ‘192.0.2.0/255.255.255.0’. For a network, can also specify wildcard bits. For example, ‘192.0.2.0/255.0.7.255’.
destination : A string representing the source IP address or network in either CIDR notation or dotted quad. For example, ‘192.0.2.0’, ‘192.0.2.0/24’, ‘192.0.2.0/255.255.255.0’. For a network, can also specify wildcard bits. For example, ‘192.0.2.0/255.0.7.255'’.
Optional Arguments
sequence : An integer ranging from <1-4294967295> where this rule is placed.
dscp : An integer ranging from <0-63> or a string representing the type of Differentiated Services Code Point (DSCP). Use this to match packets with a particular DSCP value.
fragments : A Boolean. Set to TRUE to check non-initial fragments.
precedence : An integer ranging from <0-7> or a string representing the precedence type. Use this to match packets with a particular precedence value.
no : A Boolean. Set to TRUE to stop rejecting particular packet types.
Returns
permit( protocol , source , destination , ** kwargs )
Specify packets to forward. To stop forwarding particular packet types, set the optional no argument to TRUE .
Arguments
protocol : An integer ranging from <0-255> representing the protocol number, or a string representing the protocol name.
source : A string representing the source IP address or network in either CIDR notation or dotted quad. For example, ‘192.0.2.0’, ‘192.0.2.0/24’, ‘192.0.2.0/255.255.255.0’. For a network, can also specify wildcard bits. For example, ‘192.0.2.0/255.0.7.255'’.
destination : A string representing the source IP address or network in either CIDR notation or dotted quad. For example, ‘192.0.2.0’, ‘192.0.2.0/24’, ‘192.0.2.0/255.255.255.0’. For a network, can also specify wildcard bits. For example, ‘192.0.2.0/255.0.7.255'’.
Optional Arguments
sequence : An integer ranging from <1-4294967295> where this rule is placed.
dscp : An integer ranging from <0-63> or a string representing the type of DSCP. Use this to match packets with a particular DSCP value.
fragments : A Boolean. Set to TRUE to check non-initial fragments.
precedence : An integer ranging from <0-7> or a string representing the precedence type. Use this to match packets with a particular precedence value.
no : A Boolean. Set to TRUE to stop forwarding particular packet types.
----------------------------------------------------------------------
Data and other attributes defined here:
__abstractmethods__ = frozenset([])
----------------------------------------------------------------------
Returns
set_per_entry_statistic(** kwargs )
Set the per-entry statistics in this ACL . To remove this configuration, set the optional no argument to TRUE .
Returns
set_remark( remark , ** kwargs )
Set a remark. To remove a remark, set the optional no argument to TRUE .
Optional Arguments
no : A Boolean. Set to TRUE to remove a particular remark.
sequence : An integer sequence number where the remark is placed.
Returns
----------------------------------------------------------------------
Data descriptors inherited from ACL :
Dictionary for instance variables (if defined).
List of weak references to the object (if defined).
----------------------------------------------------------------------
Data and other attributes inherited from ACL :
__metaclass__ = <class ‘abc.ABCMeta’>
Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed directly and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as ‘virtual subclasses’ -- these and their descendants are considered subclasses of the registering ABC by the built-in is subclass() function, but the registering ABC do not show up in their Method Resolution Order (MRO) nor are method implementations defined by the registering ABC callable (not even via super() ).
class IPv6ACL( name )
Use this class to configure the IPv6 ACL .
deny( protocol , source , destination , ** kwargs )
Specify packets to reject. To stop rejecting particular packet types, set the optional no argument to TRUE .
Arguments
protocol : An integer ranging from <0-255> representing the protocol number, or a string representing the protocol name.
source : A string representing the source IP network in Classless Inter-Domain Routing (CIDR) notation. For example, ‘1:1::1:1/32’.
destination : A string representing the destination IP network in CIDR notation. For example, ‘1:1::1:1/32’.
Optional Arguments
sequence : an integer ranging from <1-4294967295> where this rule is placed.
dscp : An integer ranging from <0-63> or a string representing the type of DSCP. Use this to match packets with a particular DSCP value.
fragments : A Boolean. Set to TRUE to check non-initial fragments.
no : A Boolean. Set to TRUE to stop rejecting particular packet types.
Returns
permit( protocol , source , destination , ** kwargs )
Specify packets to forward. To stop forwarding particular packet types, set the optional no argument to TRUE .
Arguments
protocol : An integer ranging from <0-255> representing the protocol number, or a string representing the protocol name.
source : A string representing the source IP network in CIDR notation. For example, ‘1:1::1:1/32’.
destination : A string representing the destination IP network in CIDR notation. For example, ‘1:1::1:1/32’.
Optional Arguments
sequence : An integer ranging from <1-4294967295> where this rule is placed.
dscp : An integer ranging from <0-63> or a string representing the type of DSCP. Use this to match packets with a particular DSCP value.
fragments : A Boolean. Set to TRUE to check non-initial fragments.
no : A Boolean. Set to TRUE to stop forwarding particular packet types.
----------------------------------------------------------------------
Data and other attributes defined here:
__abstractmethods__ = frozenset([])
----------------------------------------------------------------------
Returns
set_per_entry_statistic(** kwargs )
Set the per-entry statistics in this ACL . To remove this configuration, set the optional no argument to TRUE .
Returns
set_remark( remark , ** kwargs )
Set a remark. To remove a remark, set the optional no argument to TRUE .
Optional Arguments
no : A Boolean. Set to TRUE to remove a particular remark.
sequence : An integer sequence number where the remark is placed.
Returns
----------------------------------------------------------------------
Data descriptors inherited from ACL :
Dictionary for instance variables (if defined).
List of weak references to the object (if defined).
----------------------------------------------------------------------
Data and other attributes inherited from ACL :
__metaclass__ = <class ‘abc.ABCMeta’>
Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed directly and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as ‘virtual subclasses’ -- these and their descendants are considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won’t show up in their Method Resolution Order (MRO) nor are method implementations defined by the registering ABC callable (not even via super() ).
class Interface( intf )
System shared object. Don’t delete.
set_trunk_allowed_vlans( vlans =[] )
set_trunk_native_vlan( vlan =1 )
----------------------------------------------------------------------
interfaces(cls, refresh=FALSE) from __builtin__.type
Returns the list of interfaces on the switch
normalize(cls, intf) from __builtin__.type
parsed_if(cls, intf) from __builtin__.type
----------------------------------------------------------------------
----------------------------------------------------------------------
Data descriptors defined here:
class Key( key =‘’, start =‘’, end=‘’)
is_match( line =‘’ , key =‘’ )
----------------------------------------------------------------------
Data descriptors defined here:
class PasswordProtoTransfer( source , dest =‘’, host=(None, None) , vrf =‘management’, login_timeout =10, user =‘’, password =‘’)
setusercredentials( user , password )
----------------------------------------------------------------------
Methods inherited from Transfer :
find_local_filename( filename = ‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
----------------------------------------------------------------------
Static methods inherited from Transfer :
gettransferobj( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash: ’, vrf = ‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
----------------------------------------------------------------------
Data descriptors inherited from Transfer :
class RouteMap( name , sequence , type =‘permit’)
Use this class to create and configure route map entries.
add_description( description =None , ** kwargs )
Add a description to the route map.
Optional Arguments
exact_match : A Boolean. Set to TRUE to do exact matching of communities.
no : A Boolean. Set to TRUE to remove a community list from the match list.
Optional Arguments
exact_match : A Boolean. Set to TRUE to do exact matching of communities.
no: A Boolean. Set to TRUE to remove a community list from the match list.
Arguments
interface : A string representing an interface on the switch. Can be Ethernet, loopback, mgmt, port-channel or a VLAN in either expanded or short forms. For example, ‘e1/1.2’, ‘Ethernet1/1.2’.
Optional Arguments
external : A Boolean. Set to TRUE to match external routes (BGP, EIGRP and OSPF type 1/2).
internal : A Boolean. Set to TRUE to match internal routes (including OSPF intra/inter area)
level_1 : A Boolean. Set to TRUE to match IS-IS level-1 routes.
level_2 : A Boolean. Set to TRUE to match IS_IS level-2 routes.
local : A Boolean. Set to TRUE to match locally generated routes.
nssa_external : A Boolean. Set to TRUE to match Not-So-Stubby Area (NSSA)-external routes (OSPF type 1/2).
type_1 : A Boolean. Set to TRUE to match OSPF external type 1 routes.
type_2 : A Boolean. Set to TRUE to match OSPF external type 2 routes.
no : A Boolean. Set to TRUE to stop matching the route-type of any other parameter that was sent in.
Arguments
lists : A string that is a comma-separated list of VLANs and/or VLAN ranges where each VLAN can range from <1-3967, 4048-4093>. For example, 1-5, 10 or 2-5,7-19.
Optional Arguments
no : A Boolean. Set to TRUE to remove a list of VLANs and/or VLAN ranges from the match list.
Arguments
list : A string that is a space-separated list of ASes where each AS is in the following format: <1-4294967295>|<1-65535>[.<0-65535>].
class Routes()
add_route( srcIp =‘’ , prefix =‘’ , mask =‘’ , intf =‘’ , nexthop =‘’ , nhMask =‘’ , nhPrefix =‘’ , tag =‘’ , routePref =‘’ , vrf =‘default’ )
delete_route( srcIp =‘’ , prefix =‘’ , mask =‘’ , intf =‘’ , nexthop =‘’ , nhMask =‘’ , nhPrefix =‘’ , tag =‘’ , routePref =‘’ , vrf =’default’ )
----------------------------------------------------------------------
Data descriptors defined here:
Dictionary for instance variables (if defined).
List of weak references to the object (if defined).
----------------------------------------------------------------------
Data and other attributes defined here:
hopEntries = {‘Attached’: ‘100003’, ‘Drop’: ‘100000’, ‘Receive’: ‘1000...
validHops = {‘100000’: (‘Drop’, ‘Null0’), ‘100002’: (‘Receive’, ‘sup-e...
class SCPTransfer( source , dest =‘’, host =(None, None), vrf=‘management’, login_timeout=10, user=‘’, password=‘’)
----------------------------------------------------------------------
Methods inherited from PasswordProtoTransfer :
setusercredentials( user , password )
----------------------------------------------------------------------
Methods inherited from Transfer :
find_local_filename( filename =‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
---------------------------------------------------------------------
Static methods inherited from Transfer :
gettransferobj( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash:’ , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
----------------------------------------------------------------------
Data descriptors inherited from Transfer :
class SFTPTransfer( source , dest=‘’, host =(None, None), vrf =‘management’, login_timeout=10, user=‘’, password=‘’)
----------------------------------------------------------------------
Methods inherited from PasswordProtoTransfer :
setusercredentials( user , password )
----------------------------------------------------------------------
Methods inherited from Transfer :
find_local_filename( filename =‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
----------------------------------------------------------------------
Static methods inherited from Transfer :
gettransferobj( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash:’ , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
----------------------------------------------------------------------
Data descriptors inherited from Transfer :
class SSH()
Generate Secure Shell (SSH) keys.
Arguments
dsa : Generate Digital Signature Algorithm (DSA) keys.
rsa : Generate Ron Rivest, Adi Shamir and Leonard Adleman (RSA) keys.
Optional Arguments
bits : <768-2048>. Number of bits (only for RSA keys).
force : Force the generation of keys even if previous ones are present.
Optional Arguments
----------------------------------------------------------------------
Returns
TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class ShowInterface( ifname )
----------------------------------------------------------------------
get_xml_dom_from_cli_output( text )
key_value_colon_parser( line )
key_value_xml_parser( element )
----------------------------------------------------------------------
Data descriptors inherited from CLI :
class System(__builtin__.object)
Class to provide miscellaneous system configuration.
Get the hostname of the switch.
Set the hostname of the switch.
set_mgmt0_ip( address =None , mask =None )
Set the IPv4 or IPv6 address and netmask on mgmt0.
< ip >/< no. bits in mask > that is, 10.1.1.1/24
< ip >/< mask > that is, 10.1.1.1/255.255.255.0
set_password( username =‘admin’ , password =None , expire =None , role =None , delete =None )
Set user password and associated options.
Arguments
0—Indicates that the password that follows should be in cleartext.
5—Indicates that the password that follows should be encrypted.
WORD—Password for the user (cleartext) (max Size 64).
expire : WORD Expiry in YYYY-MM-DD format (max Size 10).
network-admin —System configured role.
network-operator —System configured role.
vdc-admin — System configured role.
vdc-operator —System configured role.
----------------------------------------------------------------------
Data descriptors defined here:
class TFTPTransfer( source , dest=‘’, host=(None, None), vrf=‘management’, login_timeout =10)
----------------------------------------------------------------------
Methods inherited from Transfer :
find_local_filename( filename =‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
----------------------------------------------------------------------
Static methods inherited from Transfer :
gettransferobj( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash:’ , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
----------------------------------------------------------------------
Data descriptors inherited from Transfer :
class Tacacs()
add_group( name , server , ** args )
Specify one or more remote authentication, authorization and accounting (AAA) servers to authenticate users using server groups. All members of a group must belong to the Terminal Access Controller Access-Control System Plus (TACACS+) protocol. The servers are tried in the same order in which you configure them.
You can configure these server groups at any time but they only take effect when you apply them to an AAA service.
Optional Arguments
deadtime =<1-1440>: Configures the monitoring dead time. The default is 0 minutes. The range is from 1 through 1440.
If the dead-time interval for a TACACS+ server group is greater than zero (0), that value takes precedence over the global dead-time value.
source_interface =‘m0’ Configures a source interface to access the TACACS+ servers in the server group. You can use Ethernet interfaces, loopback interfaces, or the management interface (mgmt 0). The default is the global source interface.
vrf =< vrf-name >: Specifies the VRF to use to contact the servers in the server group.
no = TRUE : Deletes the group.
add_server( server , ** args )
Adds TACACS+ servers. To access a remote TACACS+ server, you must configure the IP address or the hostname for the TACACS+ server on the Cisco NX-OS device. You can configure up to 64 TACACS+ servers.
Arguments
server : TACACS+ server’s Domain Name System (DNS) name or its IP address.
port =<1-65535>: TACACS+ server port.
key = CiscoSecret : Global TACACS+ server shared secret.
Example
(Optional) Applies the TACACS+ configuration changes in the temporary database to the running configuration and distributes TACACS+ configuration to other NX-OS devices in the network that you have enabled CFS configuration distribution for the TACACS+ feature.
Monitor the availability of TACACS+ servers. These parameters include the username and password to use for the server and an idle timer. The idle timer specifies the interval in which a TACACS+ server receives no requests before the Cisco NX-OS device sends out a test packet. You can configure this option to test servers periodically, or you can run a one-time-only test.
Arguments
Configure the switch to allow the user to specify which TACACS+ server to send the authentication request by enabling the directed-request option. By default, a Cisco NX-OS device forwards an authentication request based on the default AAA method. If you enable this option, the user can log in as username@vrfname:hostname , where vrfname is the VRF to use and hostname is the name of a configured TACACS+ server.
Returns
Return information for the servers.
Return list of configured servers.
Specify a TACACS+ key for all TACACS+ servers. You can specify the key-value in the cisco.CiscoSecret object , if the key is in cleartext (0) format or is encrypted (7). The Cisco NX-OS software encrypts a cleartext key before saving it to the running configuration. The default format is cleartext. The maximum length is 63 characters. By default, no secret key is configured.
Example
src_interface( ifname , ** args )
Configure a global source interface for TACACS+ server groups to use when accessing TACACS+ servers. To configure a different source interface for a specific TACACS+ server group, use the add_group() function. By default, the Cisco NX-OS software uses any available interface.
Arguments
Monitor the availability of TACACS+ servers. These parameters include the username and password to use for the server and an idle timer. The idle timer specifies the interval in which a TACACS+ server receives no requests before the Cisco NX-OS device sends out a test packet. You can configure this option to test servers periodically, or you can run a one-time-only test.
Set a global timeout interval that the Cisco NX-OS device waits for responses from all TACACS+ servers before declaring a timeout failure. The timeout interval determines how long the Cisco NX-OS device waits for responses from TACACS+ servers before declaring a timeout failure.
Arguments
----------------------------------------------------------------------
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class Transfer(source, dest=‘’, host=(None, None), vrf=‘management’, login_timeout=10)
find_local_filename( filename =‘’ )
local_file_exist( filename =‘’ )
setup( source , dest , host , vrf , login_timeout )
----------------------------------------------------------------------
gettransferobj( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash:’ , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
---------------------------------------------------------------------
Data descriptors defined here:
class VRF( vrf )
Use this object to create/delete a VRF on the switch, add/remove interfaces to a VRF or simply just to check if a VRF exists.
add_interface( if_name , ** args )
Set the specified interface’s VRF membership to this VRF.
Optional Arguments
no : A Boolean. Set to TRUE to remove this VRF from the specified interface’s VRF membership.
Example
----------------------------------------------------------------------
get_vrf_id_by_name( target_vrf_name )
Return the VRF ID associated with the specified VRF name.
get_vrf_name_by_id( target_vrf_id )
Return the VRF name associated with the specified VRF ID.
----------------------------------------------------------------------
Data descriptors defined here:
class bfd( Feature )
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class dhcp( Feature )
Enable/Disable Dynamic Host Configuration Protocol (DHCP) snooping.
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name— as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class eigrp( Feature )
Enable/Disable Enhanced Interior Gateway Routing Protocol (EIGRP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class hsrp( Feature )
Enable/Disable Hot Standby Router Protocol (HSRP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class interface-vlan( Feature )
Enable/Disable interface VLAN.
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class lacp( Feature )
Enable/Disable Link Aggregation Control Protocol (LACP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class msdp( Feature )
Enable/Disable Multicast Source Discovery Protocol (MSDP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class ospf( Feature )
Enable/Disable Open Shortest Path First Protocol (OSPF).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class ospfv3( Feature )
Enable/Disable Open Shortest Path First Version 3 Protocol (OSPFv3).
Methods inherited from Feature :
Returns
Returns TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name - as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class pim( Feature )
Enable/Disable Protocol Independent Multicast (PIM).
Methods inherited from Feature :
Returns
Returns TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class private-vlan( Feature )
Methods inherited from Feature :
Returns
Returns TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class ptp( Feature )
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
---------------------------------------------------------------------
Static methods inherited from Feature :
class rip( Feature )
Enable/Disable Routing Information Protocol (RIP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
---------------------------------------------------------------------
Static methods inherited from Feature :
class scheduler( Feature )
Methods inherited from Feature :
Returns
Returns TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class telnet( Feature )
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class udld( Feature )
Enable/Disable Unidirectional Link Detection (UDLD).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class vpc( Feature )
Enable/Disable (Virtual Port Channel) (VPC).
Methods inherited from Feature :
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class vrrp( Feature )
Enable/Disable Virtual Router Redundancy Protocol (VRRP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
class vtp( Feature )
Enable/Disable VLAN Trunking Protocol (VTP).
Methods inherited from Feature :
Returns
Return TRUE if the feature is enabled.
Feature name—as used in the config terminal command.
Feature name—as seen in the show feature command.
Return state (or states if multiple instances) of Feature .
----------------------------------------------------------------------
Static methods inherited from Feature :
__new__( typ , * args , ** kwargs )
Create single instance of object per derived class.
cfg_if( port , desc =None , vlan =None , state =None , mode =None , allowedVlan =None , channelGroup =None )
This function is deprecated. Use the Interface class.
cli( str =‘’ , do_print =FALSE )
Validate and return correct port here.
transfer( protocol =‘’ , host =‘’ , source =‘’ , dest =‘bootflash’ , vrf =‘management’ , login_timeout =10 , user =‘’ , password =‘’ )
Feedback