Vh;ZddlmZmZmZeZdZdZdZddl m Z ddl m Z ddl mZddlmZmZmZ dd lmZGd d eZGd d eZGddeZGddeZGddeZeeeeeZeej?Z gZ!dZ"e#dk(re"yy#e$rYswxYw))absolute_importdivisionprint_functiona module: api_facts author: - "Egor Zaitsev (@heuels)" - "Nikolay Dachev (@NikolayDachev)" - "Felix Fontein (@felixfontein)" version_added: 2.1.0 short_description: Collect facts from remote devices running MikroTik RouterOS using the API description: - Collects a base set of device facts from a remote device that is running RouterOS. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. - As opposed to the M(community.routeros.facts) module, it uses the RouterOS API, similar to the M(community.routeros.api) module. extends_documentation_fragment: - community.routeros.api - community.routeros.attributes - community.routeros.attributes.actiongroup_api - community.routeros.attributes.facts - community.routeros.attributes.facts_module - community.routeros.attributes.idempotent_not_modify_state attributes: platform: support: full platforms: RouterOS options: gather_subset: description: - When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include V(all), V(hardware), V(interfaces), and V(routing). - Can specify a list of values to include a larger subset. Values can also be used with an initial V(!) to specify that a specific subset should not be collected. required: false default: - all type: list elements: str seealso: - module: community.routeros.facts - module: community.routeros.api - module: community.routeros.api_find_and_modify - module: community.routeros.api_info - module: community.routeros.api_modify a` --- - name: Collect all facts from the device community.routeros.api_facts: hostname: 192.168.88.1 username: admin password: password gather_subset: all - name: Do not collect hardware facts community.routeros.api_facts: hostname: 192.168.88.1 username: admin password: password gather_subset: - "!hardware" ay ansible_facts: description: "Dictionary of IP geolocation facts for a host's IP address." returned: always type: dict contains: ansible_net_gather_subset: description: The list of fact subsets collected from the device. returned: always type: list # default ansible_net_model: description: The model name returned from the device. returned: O(gather_subset) contains V(default) type: str ansible_net_serialnum: description: The serial number of the remote device. returned: O(gather_subset) contains V(default) type: str ansible_net_version: description: The operating system version running on the remote device. returned: O(gather_subset) contains V(default) type: str ansible_net_hostname: description: The configured hostname of the device. returned: O(gather_subset) contains V(default) type: str ansible_net_arch: description: The CPU architecture of the device. returned: O(gather_subset) contains V(default) type: str ansible_net_uptime: description: The uptime of the device. returned: O(gather_subset) contains V(default) type: str ansible_net_cpu_load: description: Current CPU load. returned: O(gather_subset) contains V(default) type: str # hardware ansible_net_spacefree_mb: description: The available disk space on the remote device in MiB. returned: O(gather_subset) contains V(hardware) type: dict ansible_net_spacetotal_mb: description: The total disk space on the remote device in MiB. returned: O(gather_subset) contains V(hardware) type: dict ansible_net_memfree_mb: description: The available free memory on the remote device in MiB. returned: O(gather_subset) contains V(hardware) type: int ansible_net_memtotal_mb: description: The total memory on the remote device in MiB. returned: O(gather_subset) contains V(hardware) type: int # interfaces ansible_net_all_ipv4_addresses: description: All IPv4 addresses configured on the device. returned: O(gather_subset) contains V(interfaces) type: list ansible_net_all_ipv6_addresses: description: All IPv6 addresses configured on the device. returned: O(gather_subset) contains V(interfaces) type: list ansible_net_interfaces: description: A hash of all interfaces running on the system. returned: O(gather_subset) contains V(interfaces) type: dict ansible_net_neighbors: description: The list of neighbors from the remote device. returned: O(gather_subset) contains V(interfaces) type: dict # routing ansible_net_bgp_peer: description: A dictionary with BGP peer information. returned: O(gather_subset) contains V(routing) type: dict ansible_net_bgp_vpnv4_route: description: A dictionary with BGP vpnv4 route information. returned: O(gather_subset) contains V(routing) type: dict ansible_net_bgp_instance: description: A dictionary with BGP instance information. returned: O(gather_subset) contains V(routing) type: dict ansible_net_route: description: A dictionary for routes in all routing tables. returned: O(gather_subset) contains V(routing) type: dict ansible_net_ospf_instance: description: A dictionary with OSPF instances. returned: O(gather_subset) contains V(routing) type: dict ansible_net_ospf_neighbor: description: A dictionary with OSPF neighbors. returned: O(gather_subset) contains V(routing) type: dict ) AnsibleModule) iteritems) to_native)api_argument_speccheck_has_library create_api)LibRouterosErrorc"eZdZgZdZdZdZy) FactsBasec<||_||_i|_d|_yN)moduleapifacts responses)selfrrs p/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/routeros/plugins/modules/api_facts.py__init__zFactsBase.__init__s  cg|_|jD],}|jj|j|.yr)rCOMMANDSappend query_path)rpaths rpopulatezFactsBase.populates7MM 9D NN ! !$//$"7 8 9rc 6|jj}|D]}|j|} t|S#t$rP}|j j djdj|t|gcYd}~Sd}~wwxYw)Nz)Error while querying path {path}: {error} )rerror) rrjoinlistr rwarnformatr)rrapi_pathpartes rrzFactsBase.query_paths88==? +D}}T*H + > !  KK  HOOXXd^lP I  s ? BAB BBN)__name__ __module__ __qualname__rrrrrrrrsH 9 rrc4eZdZddgddgddggZfdZxZS)Defaultsystemidentityresource routerboardc`tt| |jd}|r!|dj d|j d<|jd}|r|dj d|j d<|dj d|j d<|dj d|j d<|dj d |j d <|jd }|rC|dj d |j d <|dj d |j d<yy)Nrnamehostnameversionzarchitecture-namearchuptimezcpu-loadcpu_loadmodelz serial-number serialnum)superr.rrgetrrdata __class__s rrzDefault.populates gt%'~~a  %)!W[[%8DJJz "~~a  $(GKK $:DJJy !!%a-@!ADJJv #'7;;x#8DJJx %)!W[[%rFrrparse_filesystem_infoparse_memory_infor@s rrzHardware.populatesJ h&(~~a    & &tAw /  " "47 + rc|j|jd|jd<|j|jd|jd<y)Nzfree-hdd-space spacefree_mbztotal-hdd-space spacetotal_mb to_megabytesr?rrrAs rrHzHardware.parse_filesystem_infosH%)%6%6txx@P7Q%R >"&*&7&7AR8S&T ?#rc|j|jd|jd<|j|jd|jd<y)Nz free-memory memfree_mbz total-memory memtotal_mbrMrOs rrIzHardware.parse_memory_info sF#'#4#4TXXm5L#M < $($5$5dhh~6N$O =!rc*|yt|dz dz S)Ni)float)rvalues rrNzHardware.to_megabytess =U|d"T))r) r)r*r+rrrHrIrNrCrDs@rrFrFs* :H,UP*rrFcVeZdZdgddgddgddggZfdZdZdZd Zd Zd Z xZ S) Interfaces interfaceipaddressipv6neighborcJtt| i|jd<g|jd<g|jd<g|jd<|jd}|r"|j |}|j ||jd}|r#|j|}|j|d|jd}|r#|j|}|j|d |jd }|r(t|j||jd<yy) N interfacesall_ipv4_addressesall_ipv6_addresses neighborsrr6ipv4r;r[) r>rWrrrparse_interfacespopulate_interfaces parse_detailpopulate_addressesr#)rrAr^rBs rrzInterfaces.populates j$(*#% < +- '(+- '("$ ;~~a  ..t4J  $ $Z 0~~a  $$T*D  # #D& 1~~a  $$T*D  # #D& 1~~a  &*4+<+r~rrrparsepopulate_result)rrArvpnv4rrrBs rrzRouting.populateos gt%'!# :(* $%%' >"  7&( ?#&( ?#~~a  ::dF+D  T 2~~a  JJt[1E  !2E :~~a  zz$/H   :~~a  JJt^fJEE  % 0~~a  zz$/H  ( ;~~a  zz$ 3H  ( ; rcpi}|D].}|j|xs|}|jdd|||<0|S)Nrx)r?rz)rrArjrrliner4s rrz Routing.parsesF D88C=,HD HHUD !E$K  rcNt|D]\}}||j||<yrri)rr4rArjrUs rrzRouting.populate_results,#D/ *JC$)DJJt S ! *rr)r)r*r+rrrrrCrDs@rr~r~ds2 #)& w'' HrsCB + Z $f P5.A  7 :CiC2*y*6LL^6*i6*r     ,++-. ?ED zFY   sB""B*)B*