VhddlmZmZmZeZdZdZdZddl Z ddl m Z ddl m Z ddlmZdd lmZdd lmZmZmZ ddlZd Zd Zedk(reyy#e$rd ZYwxYw))absolute_importdivisionprint_functionaq module: grpc_get version_added: "3.1.0" author: - "Ganesh Nalawade (@ganeshrn)" - "Gomathi Selvi S (@GomathiselviS)" short_description: Fetch configuration/state data from gRPC enabled target hosts. description: - gRPC is a high performance, open-source universal RPC framework. - This module allows the user to fetch configuration and state data from gRPC enabled devices. options: section: description: - This option specifies the string which acts as a filter to restrict the portions of the data to be retrieved from the target host device. If this option is not specified the entire configuration or state data is returned in response provided it is supported by target host. aliases: - filter type: str command: description: - The option specifies the command to be executed on the target host and return the response in result. This option is supported if the gRPC target host supports executing CLI command over the gRPC connection. type: str display: description: - Encoding scheme to use when serializing output from the device. The encoding scheme value depends on the capability of the gRPC server running on the target host. The values can be I(json), I(text) etc. type: str data_type: description: - The type of data that should be fetched from the target host. The value depends on the capability of the gRPC server running on target host. The values can be I(config), I(oper) etc. based on what is supported by the gRPC server. By default it will return both configuration and operational state data in response. type: str requirements: - grpcio - protobuf notes: - This module requires the gRPC system service be enabled on the target host being managed. - This module supports the use of connection=ansible.netcommon.grpc. - This module requires the value of 'ansible_network_os or grpc_type' configuration option (refer ansible.netcommon.grpc connection plugin documentation) be defined as an inventory variable. - Tested against iosxrv 9k version 6.1.2. z - name: Get bgp configuration data grpc_get: section: Cisco-IOS-XR-ip-static-cfg:router-static: - null - name: run cli command grpc_get: command: "show version" display: text a stdout: description: The raw string containing configuration or state data received from the gRPC server. returned: always apart from low-level errors (such as action plugin) type: str sample: '...' stdout_lines: description: The value of stdout split into a list returned: always apart from low-level errors (such as action plugin) type: list sample: ['...', '...'] output: description: A dictionary representing a JSON-formatted response, if the response is a valid json string returned: when the device response is valid JSON type: list sample: | [{ "Cisco-IOS-XR-ip-static-cfg:router-static": { "default-vrf": { "address-family": { "vrfipv4": { "vrf-unicast": { "vrf-prefixes": { "vrf-prefix": [ { "prefix": "0.0.0.0", "prefix-length": 0, "vrf-route": { "vrf-next-hop-table": { "vrf-next-hop-interface-name-next-hop-address": [ { "interface-name": "MgmtEth0/RP0/CPU0/0", "next-hop-address": "10.0.2.2" } ] } } } ] } } } } } } }] N)to_text) AnsibleModule)ConnectionError)to_list)getget_capabilitiesrun_cliTFcttddgtdtdtd}ddgg}t||d }t|}|d }|jdr6t j t j|jd}nd }|jd}|jd }|jd }|jd g} |r,|| vr(|jd|d| jdd|r'|jdds|jd|z|jd g} |r+|| vr'|jd|d| jdddi} g} |rt|||\} }nt|||\} } t j| }  | d<| rt%| | d<nt%| | d<|j&di| y #t$r|jt|dY^wxYw#t $r2}|jt|d|j"Yd }~d }~wwxYw) z entry point for module executionstrfilter)typealiases)r)sectioncommanddisplay data_typerrT) argument_specmutually_exclusivesupports_check_modeserver_capabilitiesNrrzdisplay option 'z?' is not supported on this target host. Valid value is one of 'z, ')msgsupports_cli_commandFz8command option '%s' is not supported on this target hostzdata_type option 'z>' is not supported on this target host. Valid value is one of ,changedsurrogate_then_replace)errors)rcodestdoutoutput)dictrr paramsjsondumpsyaml safe_loadr fail_jsonjoinr loads ValueErrorwarnrrr!r exit_json)rrmodule capabilities operationsrrrrsupported_displaysupported_data_typeresultr#responseerrexcs n/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/ansible/netcommon/plugins/modules/grpc_get.pymainr;sj%(4% % E" M%i01 #- F $F+L34J }}Y**T^^FMM),DEFmmI&GmmI&G k*I"y"57"33)..t46  z~~&rKsA@ 1 f 0 b .4;cH AH zFQHsAAA