Ansible के साथ नेटवर्क ऑटोमेशन: कमांड मॉड्यूल

नेटवर्क स्वचालन के विशिष्ट परिदृश्यों की बात करें तो कोई भी कमांड मॉड्यूल के एक सेट के बिना नहीं कर सकता है। इन मॉड्यूल के लिए धन्यवाद, Ansible आपको नेटवर्क उपकरणों पर कमांड चलाने की अनुमति देता है जैसे कि आप उन्हें कंसोल से सीधे प्रवेश कर रहे हैं। इसी समय, आदेशों का आउटपुट टर्मिनल विंडो में विस्मरण में डूबने के लिए न केवल फिसल जाता है, बल्कि भविष्य में बचाया और उपयोग किया जा सकता है। यह चर में लिखा जा सकता है, बाद के कार्यों में उपयोग के लिए पार्स किया गया, या मेजबान चर में भविष्य के लिए सहेजा गया।



इस पोस्ट का लक्ष्य यह दिखाना है कि किसी भी दोहराए जाने वाले नेटवर्क प्रबंधन कार्य को स्वचालित किया जा सकता है, और यह कि अन्सिबल न केवल आपको कॉन्फ़िगरेशन का प्रबंधन करने की अनुमति देता है, बल्कि दिनचर्या से छुटकारा पाने और समय बचाने में भी मदद करता है।

चलो नेटवर्क कमांड मॉड्यूल का उपयोग करने के मूल तरीकों का विश्लेषण करते हैं, जिसमें रजिस्टर पैरामीटर का उपयोग करके कमांड के आउटपुट को सहेजना भी शामिल है। हम यह भी विचार करेंगे कि होस्टवर्स का उपयोग करके कई नेटवर्क उपकरणों को कैसे स्केल किया जाए और वाट्स_एफ़ पैरामीटर और तीन अन्य संबंधित मापदंडों का उपयोग करके सशर्त निष्पादन को कैसे व्यवस्थित किया जाए: अंतराल, रिट्रीट और मैच।

विभिन्न नेटवर्क प्लेटफार्मों के अपने स्वयं के कमांड मॉड्यूल हैं, जिनमें से सभी Red Hat Ansible इंजन नेटवर्किंग ऐड-ऑन एक्सटेंशन स्तर पर समर्थित हैं:

नेटवर्क प्लेटफ़ॉर्म	मॉड्यूल * os_command
अरिस्ता eos	eos_command
सिस्को IOS / IOS-XE	ios_command
सिस्को IOS-XR	iosxr_command
सिस्को एनएक्स-ओएस	nxos_command
जुनिपर जूनो	junos_command
VyOS	vyos_command

कमांड मॉड्यूल मूल बातें

प्लेबुक पर विचार करें जो eos_command मॉड्यूल का उपयोग करके केवल शो संस्करण कमांड चलाता है:

--- - name: COMMAND MODULE PLAYBOOK hosts: eos connection: network_cli tasks: - name: EXECUTE ARISTA EOS COMMAND eos_command: commands: show version register: output - name: PRINT OUT THE OUTPUT VARIABLE debug: var: output 

यहाँ हमारे पास दो कार्य हैं और पहला उपयोग करता है eos_command एकल कमांड पैरामीटर के साथ मॉड्यूल। चूँकि हम केवल एक कमांड - शो संस्करण चलाते हैं - यह उसी लाइन पर निर्दिष्ट किया जा सकता है, जैसा कि कमांड पैरामीटर स्वयं करता है। यदि दो या अधिक टीमें हैं, तो उनमें से प्रत्येक को कमांड के बाद एक अलग लाइन पर रखा जाना चाहिए: इस उदाहरण में, हम शो वर्जन कमांड के आउटपुट को बचाने के लिए रजिस्टर कीवर्ड का उपयोग करते हैं। रजिस्टर पैरामीटर (किसी भी कार्य में इसका उपयोग किया जा सकता है) चर सेट करता है जहां हमारे कार्य का आउटपुट सहेजा जाएगा ताकि बाद में इसका उपयोग किया जा सके। हमारे उदाहरण में, इस चर को आउटपुट कहा जाता है।

हमारे उदाहरण में दूसरा कार्य डिबग मॉड्यूल का उपयोग नव निर्मित आउटपुट चर की सामग्री को प्रदर्शित करने के लिए करता है। यही है, यह वही डेटा है जिसे आप EOS डिवाइस पर कमांड लाइन इंटरफेस पर देखेंगे यदि आपने "शो संस्करण" दर्ज किया है। अंतर यह है कि हमारी प्लेबुक उन्हें टर्मिनल विंडो में दिखाएगी जिस पर आप इसे लॉन्च करते हैं। जैसा कि आप देख सकते हैं, डिबग मॉड्यूल को Ansible चर की जांच करना आसान बनाता है।

यहाँ हमारे playbook के उत्पादन है:

 PLAY [eos] ************************************************************************* TASK [execute Arista eos command] ************************************************** ok: [eos] TASK [print out the output variable] *********************************************** ok: [eos] => { "output": { "changed": false, "failed": false, "stdout": [ "Arista vEOS\nHardware version: \nSerial number: \nSystem MAC address: 0800.27ec.005e\n\nSoftware image version: 4.20.1F\nArchitecture: i386\nInternal build version: 4.20.1F-6820520.4201F\nInternal build ID: 790a11e8-5aaf-4be7-a11a-e61795d05b91\n\nUptime: 1 day, 3 hours and 23 minutes\nTotal memory: 2017324 kB\nFree memory: 1111848 kB" ], "stdout_lines": [ [ "Arista vEOS", "Hardware version: ", "Serial number: ", "System MAC address: 0800.27ec.005e", "", "Software image version: 4.20.1F", "Architecture: i386", "Internal build version: 4.20.1F-6820520.4201F", "Internal build ID: 790a11e8-5aaf-4be7-a11a-e61795d05b91", "", "Uptime: 1 day, 3 hours and 23 minutes", "Total memory: 2017324 kB", "Free memory: 1111848 kB" ] ] } } PLAY RECAP ************************************************************************* eos : ok=2 changed=0 unreachable=0 failed=0 

जैसा कि स्क्रीनशॉट से देखा जा सकता है, हमारे दोनों कार्यों ने सफलतापूर्वक काम किया। चूंकि पहला कार्य संदेशों के डिफ़ॉल्ट विस्तार स्तर का उपयोग करता है, इसलिए यह बस कहता है कि eos होस्ट ने परिणाम को ठीक के साथ पूरा किया, हरे रंग में निष्पादन की सफलता पर प्रकाश डाला। डीबग मॉड्यूल के साथ दूसरा कार्य, निष्पादित कमांड का आउटपुट लौटाता है, एक ही जानकारी को दो प्रारूपों में प्रदर्शित करता है:

• stdout
• stdout_lines

स्टडआउट अनुभाग उसी चीज़ को दिखाता है जिसे आप डिवाइस पर कमांड लाइन इंटरफ़ेस में देखेंगे, लेकिन एक लंबी लाइन के रूप में। और stdout_lines अनुभाग इस आउटपुट को लाइनों में तोड़ता है ताकि यह पढ़ने में सुविधाजनक हो। इस सूची में प्रत्येक आइटम कमांड के आउटपुट में एक अलग लाइन है।

डिवाइस पर और Ansible में कमांड के आउटपुट की तुलना करें:

Arista EOS में टीम आउटपुट	stdout_lines में Ansible
eos> छंद दिखाओ अरिस्टा vEOS हार्डवेयर संस्करण: सीरियल नंबर: सिस्टम मैक पता: 0800.27ec.005e सॉफ्टवेयर छवि संस्करण: 4.20.1F वास्तुकला: i386 आंतरिक बिल्ड संस्करण: 4.20.1F-6820520.4201F आंतरिक बिल्ड आईडी: 790a11e8-5aaf-4be7-a11a-e61795d05b91 अपटाइम: 1 दिन, 3 घंटे और 56 मिनट कुल मेमोरी: 2017324 केबी मुफ्त मेमोरी: 1116624 केबी	"Stdout_lines": [ [ "अरिस्टा वीओएसओ", "हार्डवेयर संस्करण:", "सीरियल नंबर:", "सिस्टम मैक पता: 0800.27ec.005e", "" "सॉफ्टवेयर छवि संस्करण: 4.20.1F", "वास्तुकला: i386", "आंतरिक बिल्ड संस्करण: 4.20.1F-6820520.4201F ", "आंतरिक बिल्ड आईडी: 790a11e8-5aaf-4be7-a11a-e61795d05b91 ", "" "अपटाइम: 1 दिन, 3 घंटे और 23 मिनट", "कुल मेमोरी: 2017324 kB", "मुफ्त मेमोरी: 1111848 kB" ]

यदि आप JSON और YAML से परिचित हैं, तो आप शायद पहले से ही एक विषमता पर ध्यान देते हैं: stdout_lines दो शुरुआती कोष्ठक के साथ शुरू होती है:

 "stdout_lines": [ [ 

दो शुरुआती कोष्ठक इंगित करते हैं कि stdout_lines वास्तव में लाइन सूचियों की सूची लौटाता है। यदि आप हमारे डिबग कार्य को थोड़ा संशोधित करते हैं, तो इस चिप का उपयोग कमांड के परिणामों को चुनिंदा रूप से देखने के लिए किया जा सकता है। चूंकि हमारी सूची में लाइनों की केवल एक सूची है, इसलिए इस सूची को शून्य कहा जाता है (वास्तव में, यह पहला है, लेकिन गिनती खरोंच से जाती है)। अब देखते हैं कि इससे एक अलग लाइन कैसे निकाली जाती है, उदाहरण के लिए, सिस्टम मैक एड्रेस। कमांड के आउटपुट में, यह पंक्ति एक पंक्ति में चौथा है, लेकिन जब से हम स्क्रैच से गिनती करते हैं, हमें अंततः सूची 0 से लाइन 3 की आवश्यकता होती है, दूसरे शब्दों में: output.stdout_lines [0] [3]।

  - name: print out a single line of the output variable debug: var: output.stdout_lines[0][3]   debug-   : TASK [print out a single line of the output variable] ****************************** ok: [eos] => { "output.stdout_lines[0][3]": "System MAC address: 0800.27ec.005e" } 

सूची क्रमांक क्या है और इसकी आवश्यकता क्यों है? तथ्य यह है कि एक ही कार्य के भीतर आप कई टीमें चला सकते हैं, उदाहरण के लिए, इस तरह (यहां हमारे पास तीन टीमें हैं):

 --- - hosts: eos connection: network_cli tasks: - name: execute Arista eos command eos_command: commands: - show version - show ip int br - show int status register: output - name: print out command debug: var: output.stdout_lines 

यहाँ आउटपुट कैसा दिखता है:

  "output.stdout_lines": [ [ "Arista vEOS", "Hardware version: ", "Serial number: ", "System MAC address: 0800.27ec.005e", "", "Software image version: 4.20.1F", "Architecture: i386", "Internal build version: 4.20.1F-6820520.4201F", "Internal build ID: 790a11e8-5aaf-4be7-a11a-e61795d05b91", "", "Uptime: 1 day, 4 hours and 20 minutes", "Total memory: 2017324 kB", "Free memory: 1111104 kB" ], [ "Interface IP Address Status Protocol MTU", "Ethernet1 172.16.1.1/24 up up 1500", "Management1 192.168.2.10/24 up up 1500" ], [ "Port Name Status Vlan Duplex Speed Type Flags", "Et1 connected routed full unconf EbraTestPhyPort ", "Et2 connected 1 full unconf EbraTestPhyPort ", "Et3 connected 1 full unconf EbraTestPhyPort ", "Ma1 connected routed a-full a-1G 10/100/1000" ] ] 

यहां, सूची संख्या शून्य शो संस्करण कमांड का आउटपुट है, सूची नंबर एक शो आईपी इंट ब्रा आउटपुट है, सूची नंबर दो शो इंट स्टेटस आउटपुट है। यही है, सूची संख्या उस क्रम से निर्धारित होती है जिसमें कमांड निष्पादित होते हैं।

अरिस्ता ईओएस टीमें	मिलान आउटपुट सूची
संस्करण दिखाएं	output.stdout_lines [0]
शो आईपी इंट ब्र	output.stdout_lines [1]
इंट स्टेटस दिखाओ	output.stdout_lines [2]

कमांड मॉड्यूल स्केलिंग: मेजबान चर

और यदि आप एक ही समय में कई उपकरणों पर प्लेबुक चलाते हैं तो क्या होता है?



अद्वितीय होने के लिए, आउटपुट चर को इन्वेंट्री में प्रत्येक होस्ट के लिए होस्ट चर के रूप में संग्रहीत किया जाता है । यदि हमारे पास तीन स्विच हैं, और हम उन पर अपनी प्लेबुक चलाते हैं, तो हम प्रत्येक अद्वितीय होस्ट के लिए आउटपुट चर प्राप्त करेंगे। मान लें कि हमें switch03 पर ईथरनेट 1 पोर्ट के लिए शो आईपी इंट ब्र कमांड से आईपी एड्रेस की आवश्यकता है। चूंकि शो आईपी इंट ब्रा दूसरी कमांड है जो कार्य के भाग के रूप में चलती है, और ईथरनेट 1 पर डेटा इसके आउटपुट की दूसरी पंक्ति में समाहित है, हमें stdout_lines [1] [1] लिखना होगा। किसी विशेष होस्ट के चर तक पहुँचने के लिए, हम hostvars कीवर्ड का उपयोग करते हैं और उस होस्ट की खोज करते हैं जिसे हमें नाम की आवश्यकता होती है।

यह कैसे करना है:

  - name: debug hostvar debug: var: hostvars["switch03"].output.stdout_lines[1][1] 

नतीजतन, आउटपुट में वही होता है जिसकी हमें आवश्यकता होती है:

 TASK [debug hostvar] *************************************************************** ok: [switch03] => { "hostvars[\"switch03\"].output.stdout_lines[1][1]": "Ethernet1 172.16.1.3/24 up up 1500" } 

डिफ़ॉल्ट रूप से, कार्य वर्तमान होस्ट के चर का उपयोग करता है, लेकिन hostvars आपको सीधे दूसरे होस्ट के चर का उपयोग करने की अनुमति देता है।

कमांड मॉड्यूल के साथ कार्यों में स्थितियां: Wait_for पैरामीटर

प्रतीक्षा_ के लिए पैरामीटर आपको कमांड निष्पादित होने के तुरंत बाद एक शर्त जांच लागू करने की अनुमति देता है। उदाहरण के लिए, कार्य को सफलतापूर्वक पूरा करने के लिए तभी माना जाता है जब स्टेटस चेक कमांड के आउटपुट में कुछ पाठ हो। डिफ़ॉल्ट रूप से, wa_for पैरामीटर का उपयोग नहीं किया जाता है, इसलिए कार्य केवल एक बार चलता है, जैसा कि ऊपर दिए गए उदाहरणों में है। लेकिन अगर आप इसे स्पष्ट रूप से सेट करते हैं, तो कार्य पूरा हो जाएगा जब तक कि शर्त पूरी नहीं होती है या प्रयासों की सीमा पार हो जाती है (डिफ़ॉल्ट रूप से 10 हैं)। यदि आप कमांड लॉगिंग को सक्षम करते हैं, तो आप नीचे दिए गए प्लेबुक में देख सकते हैं (जो कि विशेष रूप से लिखा गया है ताकि स्थिति कभी भी न हो), सब कुछ ठीक उसी तरह होता है।

 --- - hosts: eos connection: network_cli tasks: - name: execute Arista eos command eos_command: commands: - show int status wait_for: - result[0] contains DURHAM 

यह प्लेबुक शो इंट स्टेटस कमांड 10 बार चलाएगा, क्योंकि इसके आउटपुट में DURHAM लाइन कभी नहीं होगी।

आप लॉग लॉगिंग कमांड का उपयोग करके इसे सत्यापित कर सकते हैं:

 Mar 24 20:33:52 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=17 start_time=1521923632.5 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:33:53 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=18 start_time=1521923633.71 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:33:54 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=19 start_time=1521923634.81 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:33:55 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=20 start_time=1521923635.92 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:33:56 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=21 start_time=1521923636.99 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:33:58 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=22 start_time=1521923638.07 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:33:59 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=23 start_time=1521923639.22 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:34:00 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=24 start_time=1521923640.32 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:34:01 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=25 start_time=1521923641.4 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status Mar 24 20:34:02 eos Aaa: %ACCOUNTING-6-CMD: admin vty6 192.168.2.1 stop task_id=26 start_time=1521923642.47 timezone=UTC service=shell priv-lvl=15 cmd=show interfaces status 

अब एक वास्तविक प्लेबुक का एक उदाहरण देखते हैं, जिसमें आईपी ओस्पफ एरिया कमांड के अलावा एक डिवाइस के साथ ओएसपीएफ पड़ोस (आसन्न) स्थापित करने के लिए सब कुछ कॉन्फ़िगर किया गया है। हम इस आदेश को लागू करते हैं और फिर आउटपुट में पूर्ण शब्द की उपस्थिति की जांच करने के लिए wait_for पैरामीटर का उपयोग करते हैं: यदि यह वहां है, तो पड़ोस सफलतापूर्वक स्थापित किया गया है। यदि FULL 10 प्रयासों में प्रकट नहीं होता है, तो कार्य विफल हो जाएगा।

 --- - hosts: eos connection: network_cli tasks: - name: turn on OSPF for interface Ethernet1 eos_config: lines: - ip ospf area 0.0.0.0 parents: interface Ethernet1 - name: execute Arista eos command eos_command: commands: - show ip ospf neigh wait_for: - result[0] contains FULL 

Ansible-playbook कमांड का उपयोग करके इस प्लेबुक को चलाएं:

 ➜ ansible-playbook ospf.yml PLAY [eos] ********************************************************************************************* TASK [turn on OSPF for interface Ethernet1] ******************************************************* changed: [eos] TASK [execute Arista eos command] **************************************************************** ok: [eos] PLAY RECAP ****************************************************************************************** eos : ok=2 changed=1 unreachable=0 failed=0 

हम कमांड लाइन को देखते हैं और देखते हैं कि प्लेबुक सफल रहा:

 eos#show ip ospf neigh Neighbor ID VRF Pri State Dead Time Address Interface 2.2.2.2 default 1 FULL/DR 00:00:33 172.16.1.2 Ethernet1 

इसमें शामिल हैं, आप निम्न तुलना ऑपरेटरों का उपयोग कर सकते हैं:

• eq: - बराबर है
• neq: - नहीं के बराबर
• जी.टी.: - अधिक
• ge: - से बड़ा या बराबर
• लेफ्टिनेंट: - कम
• ले: - से कम या बराबर

इसके अलावा, Wait_for के साथ, आप तीन अतिरिक्त मापदंडों का उपयोग कर सकते हैं, (मॉड्यूल के लिए प्रलेखन में विस्तार से वर्णित):

पैरामीटर	विवरण
अंतराल	एक टीम के दोहराव के बीच का समय।
पुनर्प्रयास	मैक्स। कार्य पूरा होने से पहले दोहराव की संख्या, या स्थिति पूरी हो गई है।
मेल खाते हैं	सभी स्थितियों का संयोग या कम से कम एक।

आइए हम मैच पैरामीटर पर अधिक विस्तार से ध्यान दें:

  - name: execute Arista eos command eos_command: commands: - show ip ospf neigh match: any wait_for: - result[0] contains FULL - result[0] contains 172.16.1.2 

जब मिलान: कोई भी निर्दिष्ट किया जाता है, तो कार्य सफल माना जाता है यदि परिणाम में FULL या 172.16.1.2 होता है। यदि मिलान: सभी निर्दिष्ट है, तो परिणाम में पूर्ण और 172.16.1.2 दोनों होना चाहिए। डिफ़ॉल्ट रूप से, मैच: सभी का उपयोग किया जाता है, क्योंकि यदि आप कई शर्तों को निर्धारित करते हैं, तो सबसे अधिक संभावना है कि आप उन्हें सभी को निष्पादित करना चाहते हैं, और कम से कम एक नहीं।

कब मिल सकता है: कोई भी काम आ सकता है? मान लें कि आपको यह सत्यापित करने की आवश्यकता है कि डेटा केंद्र का इंटरनेट से दो-तरफ़ा कनेक्शन है। और डेटा सेंटर पांच अलग-अलग इंटरनेट प्रदाताओं से जुड़ा है, जिनमें से प्रत्येक का अपना बीजीपी कनेक्शन है। एक प्लेबुक इन सभी पांच कनेक्शनों की जांच कर सकता है, और यदि उनमें से कम से कम एक काम करता है, और सभी पांच नहीं, तो रिपोर्ट करें कि सब कुछ क्रम में है। बस याद रखें कि कोई भी तार्किक OR है, और सभी एक तार्किक है।

पैरामीटर	विवरण
मैच: कोई भी	तार्किक "या" कम से कम एक शर्त की आवश्यकता है
मैच: सभी	तार्किक "और" सभी शर्तों की आवश्यकता है

नकारात्मक स्थितियां: उलटे तर्क का निर्माण

कभी-कभी यह महत्वपूर्ण है कि निष्कर्ष में क्या नहीं है, लेकिन क्या नहीं है। यहां, निश्चित रूप से, यह हमेशा neq तुलना ऑपरेटर का उपयोग करने के लिए लुभाता है, लेकिन नकारात्मक स्थितियों वाले कुछ परिदृश्यों के लिए बेहतर विकल्प हैं। उदाहरण के लिए, यदि आपको समाहित कथन (प्रकार का, "कमांड के आउटपुट में ऐसा और ऐसा नहीं होना चाहिए") को उल्टा करने की आवश्यकता है, तो आप आउटपुट को बचाने के लिए रजिस्टर कीवर्ड का उपयोग कर सकते हैं, और फिर अगले कार्य में जब अभिव्यक्ति का उपयोग करके इसे संसाधित कर सकते हैं। या, उदाहरण के लिए, जब आपको शर्तें पूरी न होने पर प्लेबुक को रोकने की आवश्यकता होती है, तो विशेष रूप से त्रुटि के साथ बाहर निकलने के लिए असफल या मुखर मॉड्यूल का उपयोग करें। तुलना ऑपरेटर नीक के रूप में, यह केवल तब उपयोगी होता है जब आप आउटपुट से सटीक मान निकाल सकते हैं (उदाहरण के लिए, एक कुंजी-मूल्य जोड़ी या JSON से), और न केवल एक स्ट्रिंग या तार की सूची। अन्यथा, चरित्र-दर-तार तुलना तार का प्रदर्शन किया जाएगा।

आगे क्या है

नेटवर्क मॉड्यूल में कमांड के आउटपुट के साथ काम करने पर प्रलेखन पढ़ें। यह विशिष्ट नेटवर्क प्लेटफॉर्म पर JSON प्रारूप आउटपुट के साथ काम करते समय भू, ले और अन्य स्थितियों का उपयोग करने के उपयोगी उदाहरण प्रदान करता है।