VhHddlmZmZmZeZddgddZdZdZdZ dd l Z dd l Z dd l Z dd l mZmZmZmZd Z dd lmZd Z ddlmZd Z dd lZd ZddlmZddlm Z m!Z!m"Z"ddl#m$Z$ddl%m&Z&dZ'dZ(dZ)Gdde Z*dZ+e,dk(re+y y #e$rd ZYcwxYw#e$rd ZYgwxYw#e$rd ZYkwxYw#e$rd ZYqwxYw))absolute_importdivisionprint_functionz1.1preview certified)metadata_versionstatus supported_bya --- module: aci_rest short_description: Direct access to the Cisco APIC REST API description: - Enables the management of the Cisco ACI fabric through direct access to the Cisco APIC REST API. - Thanks to the idempotent nature of the APIC, this module is idempotent and reports changes. requirements: - lxml (when using XML payload) - xmljson >= 0.1.8 (when using XML payload) - python 2.7+ (when using xmljson) options: method: description: - The HTTP method of the request. - Using C(delete) is typically used for deleting objects. - Using C(get) is typically used for querying objects. - Using C(post) is typically used for modifying objects. type: str choices: [ delete, get, post ] default: get aliases: [ action ] path: description: - URI being used to execute API calls. - Must end in C(.xml) or C(.json). type: str required: true aliases: [ uri ] content: description: - When used instead of C(src), sets the payload of the API request directly. - This may be convenient to template simple requests. - For anything complex use the C(template) lookup plugin (see examples) or the C(template) module with parameter C(src). type: raw src: description: - Name of the absolute path of the filename that includes the body of the HTTP request being sent to the ACI fabric. - If you require a templated payload, use the C(content) parameter together with the C(template) lookup plugin, or use C(template). type: path aliases: [ config_file ] rsp_subtree_preserve: description: - Preserve the response for the provided path. type: bool default: false page_size: description: - The number of items to return in a single page. type: int page: description: - The page number to return. type: int extends_documentation_fragment: - cisco.aci.aci - cisco.aci.annotation notes: - Certain payloads are known not to be idempotent, so be careful when constructing payloads, e.g. using C(status="created") will cause idempotency issues, use C(status="modified") instead. More information in :ref:`the ACI documentation `. - Certain payloads (and used paths) are known to report no changes happened when changes did happen. This is a known APIC problem and has been reported to the vendor. A workaround for this issue exists. More information in :ref:`the ACI documentation `. - XML payloads require the C(lxml) and C(xmljson) python libraries. For JSON payloads nothing special is needed. - If you do not have any attributes, it may be necessary to add the "attributes" key with an empty dictionnary "{}" for value as the APIC does expect the entry to precede any children. - Annotation set directly in c(src) or C(content) will take precedent over the C(annotation) parameter. seealso: - module: cisco.aci.aci_tenant - name: Cisco APIC REST API Configuration Guide description: More information about the APIC REST API. link: http://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/2-x/rest_cfg/2_1_x/b_Cisco_APIC_REST_API_Configuration_Guide.html author: - Dag Wieers (@dagwieers) - Cindy Zhao (@cizhao) - Samita Bhattacharjee (@samitab) a - name: Add a tenant using certificate authentication cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key method: post path: /api/mo/uni.xml src: /home/cisco/ansible/aci/configs/aci_config.xml delegate_to: localhost - name: Add a tenant from a templated payload file from templates/ cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key method: post path: /api/mo/uni.xml content: "{{ lookup('template', 'aci/tenant.xml.j2') }}" delegate_to: localhost - name: Add a tenant using inline YAML cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key validate_certs: false path: /api/mo/uni.json method: post content: fvTenant: attributes: name: Sales descr: Sales department delegate_to: localhost - name: Add a tenant using a JSON string cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key validate_certs: false path: /api/mo/uni.json method: post content: { "fvTenant": { "attributes": { "name": "Sales", "descr": "Sales department" } } } delegate_to: localhost - name: Add a tenant using an XML string cisco.aci.aci_rest: host: apic username: admin private_key: pki/{{ aci_username }}.key validate_certs: false path: /api/mo/uni.xml method: post content: '' delegate_to: localhost - name: Get tenants using password authentication cisco.aci.aci_rest: host: apic username: admin password: SomeSecretPassword method: get path: /api/node/class/fvTenant.json delegate_to: localhost register: query_result - name: Get first 5 tenants using password authentication and pagination cisco.aci.aci_rest: host: apic username: admin password: SomeSecretPassword method: get page_size: 5 path: /api/node/class/fvTenant.json delegate_to: localhost register: query_result - name: Configure contracts cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key method: post path: /api/mo/uni.xml src: /home/cisco/ansible/aci/configs/contract_config.xml delegate_to: localhost - name: Register leaves and spines cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key validate_certs: false method: post path: /api/mo/uni/controller/nodeidentpol.xml content: with_items: - '{{ apic_leavesspines }}' delegate_to: localhost - name: Wait for all controllers to become ready cisco.aci.aci_rest: host: apic username: admin private_key: pki/admin.key validate_certs: false path: /api/node/class/topSystem.json?query-target-filter=eq(topSystem.role,"controller") register: apics until: "'totalCount' in apics and apics.totalCount|int >= groups['apic']|count" retries: 120 delay: 30 delegate_to: localhost run_once: true a~ error_code: description: The REST ACI return code, useful for troubleshooting on failure returned: always type: int sample: 122 error_text: description: The REST ACI descriptive text, useful for troubleshooting on failure returned: always type: str sample: unknown managed object class foo imdata: description: Converted output returned by the APIC REST (register this for post-processing) returned: always type: str sample: [{"error": {"attributes": {"code": "122", "text": "unknown managed object class foo"}}}] payload: description: The (templated) payload send to the APIC REST API (xml or json) returned: always type: str sample: '' raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error type: str sample: '' response: description: HTTP response string returned: always type: str sample: 'HTTP Error 400: Bad Request' status: description: HTTP status code returned: always type: int sample: 400 totalCount: description: Number of items in the imdata array returned: always type: str sample: '0' url: description: URL used for APIC REST call returned: success type: str sample: https://1.2.3.4/api/mo/uni/tn-[Dag].json?rsp-subtree=modified N) parse_qsl urlencodeurlparse urlunparseTF)etree)cobra) AnsibleModule) ACIModuleaci_argument_specaci_annotation_spec)to_text)ANNOTATION_UNSUPPORTEDc trUtt|}tt |d}|j |t ||d<t|Sd|vr=|dzdj|jDcgc] \}}|d|c}}zS|dzdj|jDcgc] \}}|d|c}}zScc}}wcc}}w)z Add or update a URL query string?&=) HAS_URLPARSElistr dictr updater rjoinitems)urlparams url_partsquerykvs f/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_rest.py update_qslr)=s#' Yy|,- V ' ! )$$ Sy388&,,.$Q$!Q1%5$QRRRSy388&,,.$Q$!Q1%5$QRRR%R$Qs C ?C c2|rt|tr|jD]p\}}|tvrt|ts |j di}d|j vr||d<|j dd}|s^|D]}t ||ryyy)z?Add annotation to payload only if it has not already been added attributes annotationchildrenN) isinstancerr!rgetkeysadd_annotation)r,payloadkeyvalattr-childs r(r1r1Lsj$/  :HC,,#t$gglB/sxxz1(2C %77:t4!):&z59: :0zc|rO|jD];}|jtvr|jd}|*|j d|=yy)zCAdd annotation to payload xml only if it has not already been addedr,N)itertagrr/set)r,treeelementanns r(add_annotation_xmlr?]sPyy{ 6G{{44++l+C{ L*5  6r7ceZdZdZddZy) ACIRESTModulect|tr9|jD]%\}}|dk(r|dvry|j|dus%yyt|tr|D]}|j|dusyy)zCheck ACI response for changesr )createdmodifieddeletedTF)r.rr!changedr)selfdr&r'is r(rFzACIRESTModule.changedis a   1=Q*L%L\\!_,   4  <<?d* r7c|dk(r|j|n|j|tr)|j|j|j d<yy)zHandle APIC response outputjsonrFN) response_json response_xmlrrFimdataresult)rG rawoutput rest_types r( response_typezACIRESTModule.response_typeysM     y )   i ( %)\\$++%>DKK " r7N)xml)__name__ __module__ __qualname__rFrRr7r(rArAhs  ?r7rAc t}|jt|jtdddgtddgddgtd d g td tddtd td t |dddgg}|j j d}|j j d }|j j d}|j j d}|j j d}|j j d}|j j d}|j j ddk7r|r|jdd} |rCtjj|rd} n!|jdj||jddk7r3d } ts|jd!ts<|jd"n)|jd#dk7rd$} n|jd%t|} d| j d&<|} | r%t#|d'5} | j%} ddd d$k(r|r2t'|tr"t)|| t+j,| } n| rt'| t.rt0r t3j4| } t)|| t+j,| } n| d k(rtr|rPt'|tr@tr:t)|| t;j<t?j:| d*d+,} nK| rIt'| t.r9 t;j@| } tC|| t;j<| d+,} |jEd/| _ d0j| jF| j| _$| j j ddk(r>|r| jdjqd<jsd?d*@| _$|| _:d| j dA<| r|dBk(r| d$k(rt+jv| } | | j dC<| j j dD}|Lt#|dE5}| d$k(rt+jx| g|n|j{t/| ddd| j|dFi| j y#1swYxYw#t6$r@}|jd(jt9|t9|| )Yd}~d}~wwxYw#t6$r6}|jd-jt9|| .Yd}~d}~wwxYw#tZ$r%| jd9jW|YwxYw#t\$r%| jU|j d7| YwxYw#1swY$xYw)GNstrTuri)typerequiredaliasesr/)deleter/postaction)r[defaultchoicesr]path config_file)r[r]raw)r[boolF)r[raint)rcmethodsrccontentrsp_subtree_preserve page_sizepagerjri) argument_specsupports_check_modemutually_exclusiverkr,rlrmrhzHPagination parameters (page and page_size) are only valid for GET method)msgzCannot find/access src '{0}'z.xmlrSz;The lxml python library is missing, or lacks etree support.z>The xmljson python library is missing, or lacks cobra support.z.jsonrKz>Failed to find REST API payload type (neither .xml nor .json).r rz/Failed to parse provided JSON/YAML payload: {0})rq exceptionr2runicode)encodingz)Failed to parse provided XML payload: {0})rqr2/z{0}/{1})rmz page-sizez{0}?rsp-subtree=modifiedz rsp-subtreerD)datareturn_responsebodyzAPIC Error {code}: {text}z"Connection failed for {url}. {msg}rN totalCounthostz[[\]],)netlocrFPOSTproposed output_patharW)?rrrrrr#r/ fail_jsonosrcisfileformatfindHAS_LXML_ETREEHAS_XMLJSON_COBRArArOopenreadr.r1rKdumpsrYHAS_YAMLyaml safe_load Exceptionrrtostringr fromstringr?lstripbase_urlr"r)uppermodule check_modeapi_callrR format_maperrorKeyErrorAttributeErrorr rNr| connectionrr _replaceresub get_optionsplitrhloadsdumpwrite exit_json)rnrrjrcrirkr,rlrm file_existsrQacir2 config_objecterhrespinfor output_files r(mainrs%'M,./ uteW =7P[cZde f}o 6% !vu=E" u # &./F mm *G ==  V $D --  E "C!==,,-CD""<0J !!+.I ==  V $D }}"e+ ghK 77>># K   !?!F!Fs!K  L yyB    !^  _   !a  b 7 r ! ]^  CCJJxG #s^ +}#((*G + F z'40 :w /jj)G GS1h R..1z73**W- e  z'405F :w /nnU[[%9!%SWW}j&AB ZZ^^H % + + -F :: \\&#''QU\V d 88H  $ Y!!$v, : "="H"H"S T  ;   diik9 5 #zz 8"zz 8#&>> <  >> %#**..*@*H #''!2!;!;266(TVX[XfXfXqXqrxXyCzDADABEDFGHDI!;"JKCG $ 96V#  jj)G!( :jjnn]3  "k3' 4;&IIwi5%%c'l3  4CMMCJJy + +  R  %V%]%]^efg^h%iu|}~uJQ RR R v  %P%W%WX_`aXb%cmt uu v2 Y "F"Q"QRV"W X Y  ;   dhhv. : ;2 4 4sm/\<6] 8^)A_* `8`9<] ^5^  ^ _+__*``*`65`69a__main__)- __future__rrrr[ __metaclass__ANSIBLE_METADATA DOCUMENTATIONEXAMPLESRETURNrKrr+ansible.module_utils.six.moves.urllib.parser r r rrrlxmlrr ImportErrorxmljsonrrrransible.module_utils.basicr6ansible_collections.cisco.aci.plugins.module_utils.acirrransible.module_utils._textrIansible_collections.cisco.aci.plugins.module_utils.annotation_unsupportedrr)r1r?rArrTrWr7r(rs!A@ (-)VabQ f~ @. ` ffL N  H5tt. S:"6?I?