CISCO ASA REST API एप
निर्देशनहरू प्रयोग गरेर उत्पादन
माथिview
Cisco को ASA REST API को रिलीज संग, तपाईसँग अब व्यक्तिगत सिस्को ASAs कन्फिगर र प्रबन्ध गर्न को लागी अर्को हल्का, प्रयोग गर्न सजिलो विकल्प छ। ASA REST API RESTful सिद्धान्तहरूमा आधारित अनुप्रयोग प्रोग्रामिङ इन्टरफेस (API) हो। यसलाई छिटो डाउनलोड गर्न सकिन्छ र API चलिरहेको कुनै पनि ASA मा सक्षम गर्न सकिन्छ। सिस्को सिस्टम्स, इंक।
ASA REST API अनुरोध र प्रतिक्रियाहरू
तपाइँको ब्राउजरमा REST क्लाइन्ट स्थापना गरेपछि, तपाइँ विशिष्ट ASA को REST एजेन्टलाई सम्पर्क गर्न सक्नुहुन्छ र हालको कन्फिगरेसन जानकारी पहुँच गर्न र थप कन्फिगरेसन प्यारामिटरहरू जारी गर्न मानक HTTP विधिहरू प्रयोग गर्न सक्नुहुन्छ।
सावधानी: जब ASA मा REST API सक्षम हुन्छ, अन्य सुरक्षा व्यवस्थापन प्रोटोकलहरूद्वारा जडानहरू अवरुद्ध हुँदैनन्। यसको मतलब CLI, ASDM, वा सुरक्षा प्रबन्धक प्रयोग गर्ने अरूहरूले ASA कन्फिगरेसन परिवर्तन गरिरहनुभएको छ जब तपाईं त्यसै गर्दै हुनुहुन्छ।
अनुरोध संरचना
ASA REST API ले तपाइँलाई एक प्रतिनिधि राज्य स्थानान्तरण (REST) API मार्फत व्यक्तिगत ASAs व्यवस्थापन गर्न प्रोग्रामेटिक पहुँच दिन्छ। API ले बाह्य ग्राहकहरूलाई ASA स्रोतहरूमा CRUD (सिर्जना, पढ्नुहोस्, अपडेट गर्नुहोस्, मेटाउनुहोस्) सञ्चालन गर्न अनुमति दिन्छ। सबै API अनुरोधहरू HTTPS मार्फत ASA मा पठाइन्छ, र जवाफ फर्काइन्छ।
जहाँ वस्तु गुणहरू छन्:
सम्पत्ति | टाइप गर्नुहोस् | विवरण |
---|---|---|
सन्देशहरू | शब्दकोशहरूको सूची | त्रुटि वा चेतावनी सन्देशहरूको सूची |
कोड | स्ट्रिङ | त्रुटि/चेतावनी/जानकारीसँग सम्बन्धित विस्तृत सन्देश |
विवरण | स्ट्रिङ | त्रुटि/चेतावनी/जानकारीसँग सम्बन्धित विस्तृत सन्देश |
नोट: REST API कलहरूद्वारा गरिएका परिवर्तनहरू स्टार्टअप कन्फिगरेसनमा कायम रहँदैनन् तर चलिरहेको कन्फिगरेसनमा मात्र नियुक्त गरिन्छन्। स्टार्टअप कन्फिगरेसनमा परिवर्तनहरू बचत गर्न, तपाईंले POST a write mem API अनुरोध प्रयोग गर्न सक्नुहुन्छ। थप जानकारीको लागि, ASA REST API सामग्रीहरूको तालिकामा लेख्नुहोस् मेमोरी API प्रविष्टिलाई सन्दर्भ गर्नुहोस्।
ASA REST API एजेन्ट र ग्राहक स्थापना र कन्फिगर गर्नुहोस्
नोट: REST API एजेन्ट जाभा-आधारित अनुप्रयोग हो। Java Runtime Environment (JRE) REST API एजेन्ट प्याकेजमा बन्डल गरिएको छ।
माथिview
व्यक्तिगत सिस्को ASAs कन्फिगर र प्रबन्ध गर्नका लागि धेरै विकल्पहरू उपलब्ध छन्:
- कमाण्ड लाइन इन्टरफेस (CLI) - तपाईले ASA लाई सिधै जडान कन्सोल मार्फत नियन्त्रण आदेशहरू पठाउनुहुन्छ।
- Adaptive Security Device Manager (ASDM) - ग्राफिकल प्रयोगकर्ता इन्टरफेसको साथ एउटा "अन-बक्स" व्यवस्थापन अनुप्रयोग जुन तपाईंले ASA कन्फिगर, व्यवस्थापन र निगरानी गर्न प्रयोग गर्न सक्नुहुन्छ।
- सिस्को सुरक्षा प्रबन्धक - धेरै सुरक्षा उपकरणहरूको मध्यम देखि ठूला नेटवर्कहरूको लागि अभिप्रेरित हुँदा, यो ग्राफिकल अनुप्रयोग व्यक्तिगत ASAs कन्फिगर, व्यवस्थापन र निगरानी गर्न प्रयोग गर्न सकिन्छ।
Cisco को ASA REST API को रिलीज संग, अब तपाईसँग अर्को हल्का, प्रयोग गर्न सजिलो विकल्प छ। यो एउटा एप्लिकेसन प्रोग्रामिङ इन्टरफेस (एपीआई) हो, "रेस्टफुल" सिद्धान्तहरूमा आधारित छ, जसलाई तपाईंले एपीआई चलिरहेको कुनै पनि ASA मा छिटो डाउनलोड र सक्षम गर्न सक्नुहुन्छ।
तपाइँको ब्राउजरमा REST क्लाइन्ट स्थापना गरेपछि, तपाइँ विशिष्ट ASA को REST एजेन्टलाई सम्पर्क गर्न सक्नुहुन्छ र हालको कन्फिगरेसन जानकारी पहुँच गर्न मानक HTTP विधिहरू प्रयोग गर्न सक्नुहुन्छ, र थप कन्फिगरेसन प्यारामिटरहरू जारी गर्न सक्नुहुन्छ।
सावधानी: जब ASA मा REST API सक्षम हुन्छ, अन्य सुरक्षा व्यवस्थापन प्रोटोकलहरूद्वारा जडानहरू अवरुद्ध हुँदैनन्। यसको मतलब CLI, ASDM, वा सुरक्षा प्रबन्धक प्रयोग गर्ने अरूहरूले ASA कन्फिगरेसन परिवर्तन गरिरहनुभएको छ जब तपाईं त्यसै गर्दै हुनुहुन्छ।
ASA REST API अनुरोध र प्रतिक्रियाहरू
ASA REST API ले तपाईंलाई एक प्रतिनिधि राज्य स्थानान्तरण (REST) API मार्फत व्यक्तिगत ASAs व्यवस्थापन गर्न प्रोग्रामेटिक पहुँच दिन्छ। API ले बाह्य क्लाइन्टहरूलाई ASA स्रोतहरूमा CRUD (सिर्जना, पढ्नुहोस्, अपडेट गर्नुहोस्, मेटाउनुहोस्) सञ्चालन गर्न अनुमति दिन्छ। यो HTTPS प्रोटोकल र REST पद्धतिमा आधारित छ। सबै API अनुरोधहरू HTTPS मार्फत ASA मा पठाइन्छ, र जवाफ फर्काइन्छ। यो खण्ड एक ओभर प्रदान गर्दछview अनुरोधहरू कसरी संरचित हुन्छन्, र अपेक्षित प्रतिक्रियाहरू,
अनुरोध संरचना
उपलब्ध अनुरोध विधिहरू हुन्:
- GET - निर्दिष्ट वस्तुबाट डाटा पुन: प्राप्त गर्दछ।
- PUT - निर्दिष्ट वस्तुमा आपूर्ति जानकारी थप्छ; यदि वस्तु अवस्थित छैन भने 404 स्रोत फेला परेन त्रुटि फर्काउँछ।
- POST - आपूर्ति गरिएको जानकारीको साथ वस्तु सिर्जना गर्दछ।
- DELETE - निर्दिष्ट वस्तु मेटाउँछ।
- PATCH - निर्दिष्ट वस्तुमा आंशिक परिमार्जनहरू लागू गर्दछ।
प्रतिक्रिया संरचना
- प्रत्येक अनुरोधले मानक हेडर, प्रतिक्रिया सामग्री, र स्थिति कोडको साथ ASA बाट HTTPS प्रतिक्रिया उत्पादन गर्दछ।
प्रतिक्रिया संरचना हुन सक्छ:
- स्थान - नयाँ सिर्जना गरिएको स्रोत आईडी; POST को लागि मात्र - नयाँ स्रोत ID राख्छ (यूआरआई प्रतिनिधित्वको रूपमा)।
- सामग्री-प्रकार - प्रतिक्रिया सन्देश मुख्य भाग वर्णन मिडिया प्रकार; प्रतिक्रिया सन्देश मुख्य भाग को प्रतिनिधित्व र वाक्य रचना वर्णन गर्दछ।
प्रत्येक प्रतिक्रियामा HTTP स्थिति वा त्रुटि कोड समावेश हुन्छ। उपलब्ध कोडहरू यी कोटीहरूमा पर्छन्:
- 20x - दुई-सय श्रृंखला कोडले सफल सञ्चालनलाई संकेत गर्दछ, सहित:
- 200 OK - सफल अनुरोधहरूको लागि मानक प्रतिक्रिया।
- 201 सिर्जना गरियो - अनुरोध पूरा भयो; नयाँ स्रोत सिर्जना गरियो।
- 202 स्वीकृत - अनुरोध स्वीकार गरियो, तर प्रक्रिया पूरा भएन।
- 204 कुनै सामग्री छैन - सर्भरले सफलतापूर्वक अनुरोध प्रशोधन गर्यो; कुनै सामग्री फिर्ता भइरहेको छैन।
- 4xx - चार-सय श्रृंखला कोडले क्लाइन्ट-साइड त्रुटिलाई संकेत गर्दछ, सहित:
- 400 खराब अनुरोध - अमान्य क्वेरी प्यारामिटरहरू, अपरिचित प्यारामिटरहरू, छुटेका प्यारामिटरहरू, वा अमान्य मानहरू सहित।
- 404 फेला परेन - प्रदान गरिएको URL अवस्थित स्रोतसँग मेल खाँदैन। पूर्वका लागिample, एक HTTP DELETE असफल हुन सक्छ किनभने संसाधन अनुपलब्ध छ।
- 405 विधिलाई अनुमति छैन - एक HTTP अनुरोध प्रस्तुत गरिएको थियो जुन स्रोतमा अनुमति छैन; पूर्वका लागिample, एक पढ्ने मात्र स्रोत मा एक POST।
- 5xx - पाँच सय श्रृंखला कोडले सर्भर-साइड त्रुटिलाई संकेत गर्दछ।
त्रुटिको अवस्थामा, त्रुटि कोडको अतिरिक्त, फिर्ता प्रतिक्रियामा त्रुटिको बारेमा थप विवरणहरू समावेश भएको त्रुटि वस्तु समावेश हुन सक्छ। JSON त्रुटि/चेतावनी प्रतिक्रिया योजना निम्नानुसार छ:
जहाँ वस्तु गुणहरू छन्:
सम्पत्ति | टाइप गर्नुहोस् | विवरण |
सन्देशहरू | शब्दकोशहरूको सूची | त्रुटि वा चेतावनी सन्देशहरूको सूची |
कोड | स्ट्रिङ | त्रुटि/चेतावनी/जानकारी कोड |
विवरण | स्ट्रिङ | त्रुटि/चेतावनी/जानकारीसँग सम्बन्धित विस्तृत सन्देश |
नोट: REST API कलहरूद्वारा गरिएको ASA कन्फिगरेसनमा परिवर्तनहरू स्टार्टअप कन्फिगरेसनमा कायम रहँदैनन्; अर्थात्, चलिरहेको कन्फिगरेसनमा मात्र परिवर्तनहरू तोकिएका छन्। स्टार्टअप कन्फिगरेसनमा परिवर्तनहरू बचत गर्न, तपाईंले writemem API अनुरोध पोस्ट गर्न सक्नुहुन्छ; थप जानकारीको लागि, सामग्रीहरूको ASA REST API तालिकाको बारेमा "Memory API लेख्नुहोस्" प्रविष्टिलाई पछ्याउनुहोस्।
ASA REST API एजेन्ट र ग्राहक स्थापना र कन्फिगर गर्नुहोस्
- REST API एजेन्टलाई अन्य ASA छविहरूसँग व्यक्तिगत रूपमा प्रकाशित गरिएको छ cisco.com। भौतिक ASA को लागि, REST API प्याकेज यन्त्रको फ्ल्यासमा डाउनलोड गरी "rest-api image" आदेश प्रयोग गरेर स्थापना गरिनुपर्छ। REST API एजेन्टलाई "rest-api एजेन्ट" आदेश प्रयोग गरेर सक्षम पारिएको छ।
- भर्चुअल ASA (ASAv) को साथ, REST API छवि "boot:" विभाजनमा डाउनलोड गर्नुपर्छ। तपाईंले त्यसपछि "rest-api छवि" आदेश जारी गर्नुपर्छ, त्यसपछि "rest-api एजेन्ट" आदेश, पहुँच गर्न र REST API एजेन्ट सक्षम गर्न।
- REST API सफ्टवेयर र हार्डवेयर आवश्यकताहरू र अनुकूलता बारे जानकारीको लागि, Cisco ASA अनुकूलता म्याट्रिक्स हेर्नुहोस्।
- तपाइँ तपाइँको ASA वा ASAv को लागी उपयुक्त REST API प्याकेज बाट डाउनलोड गर्न सक्नुहुन्छ software.cisco.com/download/home। विशिष्ट Adaptive Security Appliances (ASA) मोडेल पत्ता लगाउनुहोस् र त्यसपछि Adaptive Security Appliance REST API प्लगइन छान्नुहोस्।
नोट: REST API एजेन्ट जाभा-आधारित अनुप्रयोग हो। Java Runtime Environment (JRE) REST API एजेन्ट प्याकेजमा बन्डल गरिएको छ।
उपयोग दिशानिर्देश
महत्त्वपूर्ण तपाईंले हेडर प्रयोगकर्ता-एजेन्ट समावेश गर्नुपर्छ: REST API एजेन्ट सबै API कलहरू र अवस्थित स्क्रिप्टहरूमा। C को लागि -H 'प्रयोगकर्ता-एजेन्ट: REST API एजेन्ट' प्रयोग गर्नुहोस्URL आदेश। बहु-सन्दर्भ मोडमा, REST API एजेन्ट आदेशहरू प्रणाली सन्दर्भमा मात्र उपलब्ध छन्।
अधिकतम समर्थित कन्फिगरेसन आकार
ASA Rest API भौतिक ASA भित्र चलिरहेको "अन-बोर्ड" अनुप्रयोग हो, र जसरी यसमा छुट्याइएको मेमोरीमा सीमितता छ। हालैका प्लेटफर्महरू जस्तै 2 र 5555 मा रिलीज चक्रमा अधिकतम समर्थित चलिरहेको कन्फिगरेसन साइज लगभग 5585 MB मा बढेको छ। ASA Rest API सँग भर्चुअल ASA प्लेटफर्महरूमा मेमोरी अवरोधहरू पनि छन्। ASAv5 मा कुल मेमोरी 1.5 GB हुन सक्छ, जबकि ASAv10 मा यो 2 GB छ। बाँकी API सीमाहरू ASAv450 र ASAv500 को लागि क्रमशः 5 KB र 10 KB छन्।
त्यसकारण, सचेत रहनुहोस् कि ठूला चलिरहेको कन्फिगरेसनहरूले विभिन्न मेमोरी-गहन अवस्थाहरूमा अपवादहरू उत्पादन गर्न सक्छन् जस्तै ठूलो संख्यामा समवर्ती अनुरोधहरू, वा ठूलो अनुरोध भोल्युमहरू। यी अवस्थाहरूमा, Rest API GET/PUT/POST कलहरू 500 - आन्तरिक सर्भर त्रुटि सन्देशहरूसँग असफल हुन सुरु हुन सक्छ, र बाँकी API एजेन्ट प्रत्येक पटक स्वचालित रूपमा पुन: सुरु हुनेछ। यस अवस्थाको समाधानहरू या त उच्च-मेमोरी ASA/FPR वा ASAV प्लेटफर्महरूमा सार्ने हो, वा चलिरहेको कन्फिगरेसनको आकार घटाउनुहोस्।
REST API एजेन्ट डाउनलोड र स्थापना गर्नुहोस्
CLI को प्रयोग गरेर, ASA REST API एजेन्ट डाउनलोड र स्थापना गर्नको लागि विशेष ASA मा यी चरणहरू पालना गर्नुहोस्:
- चरण १: इच्छित ASA मा, प्रतिलिपि जारी गर्नुहोस् disk0: हालको ASA REST API प्याकेजबाट डाउनलोड गर्न आदेश cisco.com ASA को फ्ल्यास मेमोरीमा।
- पूर्वका लागिampLe: प्रतिलिपि tftp://10.7.0.80/asa-restapi-111-lfbff-k8.SPA disk0:
- चरण १: बाँकी-एपीआई छवि डिस्क० जारी गर्नुहोस्:/ प्याकेज प्रमाणित गर्न र स्थापना गर्न आदेश।
- पूर्वका लागिampLe: rest-api image disk0:/asa-restapi-111-lfbff-k8.SPA
स्थापनाकर्ताले अनुकूलता र प्रमाणीकरण जाँचहरू प्रदर्शन गर्नेछ, र त्यसपछि प्याकेज स्थापना गर्नेछ। ASA रिबुट हुने छैन।
REST API एजेन्ट सक्षम गर्नुहोस्
एक विशिष्ट ASA मा ASA REST API एजेन्ट सक्षम गर्न यी चरणहरू पालना गर्नुहोस्:
- चरण १: ASA मा सही सफ्टवेयर छवि स्थापना भएको सुनिश्चित गर्नुहोस्।
- ASA कम्प्याटिबिलिटी म्याट्रिक्सको REST API खण्डलाई परामर्श गर्नुहोस् (https://www.cisco.com/c/en/us/td/docs/security/asa/compatibility/asamatrx.html#pgfId-131643) कुन ASA छवि आवश्यक छ निर्धारण गर्न।
- चरण १: CLI को प्रयोग गरेर, ASA मा HTTP सर्भर सक्षम गरिएको सुनिश्चित गर्नुहोस्, र API क्लाइन्टहरूले व्यवस्थापन इन्टरफेसमा जडान गर्न सक्छन्।
- पूर्वका लागिampLe: http सर्भर सक्षम
- http 0.0.0.0 0.0.0.0
- चरण १: CLI प्रयोग गरेर, API जडानहरूको लागि HTTP प्रमाणीकरण परिभाषित गर्नुहोस्। पूर्वका लागिample: aaa प्रमाणीकरण http कन्सोल स्थानीय
- चरण १: CLI प्रयोग गरेर, API ट्राफिकको लागि ASA मा स्थिर मार्ग सिर्जना गर्नुहोस्। पूर्वका लागिample: मार्ग ०.०.०.० ०.०.०.० १
- चरण १: CLI प्रयोग गरेर, ASA मा ASA REST API एजेन्ट सक्षम गर्नुहोस्। पूर्वका लागिample: rest-api एजेन्ट
REST API प्रमाणीकरण
प्रमाणीकरण गर्ने दुई तरिकाहरू छन्: आधारभूत HTTP प्रमाणीकरण, जसले प्रत्येक अनुरोधमा प्रयोगकर्ता नाम र पासवर्ड पास गर्छ, वा सुरक्षित HTTPS यातायातको साथ टोकन-आधारित प्रमाणीकरण, जुन प्रत्येक अनुरोधको साथ पहिले सिर्जना गरिएको टोकन पास गर्दछ। जे भए पनि, प्रत्येक अनुरोधको लागि प्रमाणीकरण गरिनेछ। टोकन-आधारित प्रमाणीकरणको बारेमा थप जानकारीको लागि ASA REST API v7.14(x) गाइडको बारेमा खण्ड, "Token_Authentication_API" हेर्नुहोस्।
नोट: ASA मा सर्टिफिकेट अथॉरिटी (CA) द्वारा जारी प्रमाणपत्रहरूको प्रयोग सिफारिस गरिन्छ, त्यसैले REST API क्लाइन्टहरूले SSL जडानहरू स्थापना गर्दा ASA सर्भर प्रमाणपत्रहरू मान्य गर्न सक्छन्।
आदेश प्राधिकरण
यदि आदेश प्राधिकरण बाह्य AAA सर्भर प्रयोग गर्न कन्फिगर गरिएको छ (पूर्वको लागिample, aaa प्राधिकरण आदेश ), त्यसपछि enable_1 नामक प्रयोगकर्ता त्यो सर्भरमा पूर्ण कमाण्ड विशेषाधिकारहरूसँग अवस्थित हुनुपर्छ। यदि आदेश प्राधिकरण ASA को LOCAL डाटाबेस (aaa प्राधिकरण आदेश LOCAL) प्रयोग गर्न कन्फिगर गरिएको छ, तब सबै REST API प्रयोगकर्ताहरू उनीहरूको भूमिकाका लागि उपयुक्त हुने विशेषाधिकार स्तरहरूको साथ LOCAL डाटाबेसमा दर्ता हुनुपर्छ:
- अनुगमन अनुरोधहरू आह्वान गर्न विशेषाधिकार स्तर 3 वा माथि आवश्यक छ।
- GET अनुरोधहरू बोलाउनको लागि विशेषाधिकार स्तर 5 वा सोभन्दा माथि आवश्यक छ।
- PUT/POST/DELETE सञ्चालनहरू बोलाउनको लागि विशेषाधिकार स्तर 15 आवश्यक छ।
आफ्नो REST API क्लाइन्ट कन्फिगर गर्नुहोस्
तपाईंको स्थानीय-होस्ट ब्राउजरमा REST API क्लाइन्ट स्थापना र कन्फिगर गर्न यी चरणहरू पालना गर्नुहोस्:
- चरण १: तपाईको ब्राउजरको लागि REST API क्लाइन्ट प्राप्त गर्नुहोस् र स्थापना गर्नुहोस्।
- Chrome को लागि, Google बाट REST क्लाइन्ट स्थापना गर्नुहोस्। फायरफक्सको लागि, RESTClient एड-अन स्थापना गर्नुहोस्। इन्टरनेट एक्सप्लोरर समर्थित छैन।
- चरण १: तपाइँको ब्राउजर प्रयोग गरी निम्न अनुरोध सुरु गर्नुहोस्: https: /api/objects/networkobjects
- यदि तपाईंले त्रुटिरहित प्रतिक्रिया प्राप्त गर्नुभयो भने, तपाईं ASA मा काम गर्ने REST API एजेन्टमा पुग्नुभएको छ।
- यदि तपाइँलाई एजेन्ट अनुरोधमा समस्याहरू छन् भने, तपाइँ CLI कन्सोलमा डिबगिङ जानकारीको प्रदर्शन सक्षम गर्न सक्नुहुन्छ, जसरी ASA मा REST API डिबगिङ सक्षम गर्ने मा वर्णन गरिएको छ।
- चरण १: वैकल्पिक रूपमा, तपाईंले POST सञ्चालन गरेर ASA मा आफ्नो जडान परीक्षण गर्न सक्नुहुन्छ।
पूर्वका लागिampLe: आधारभूत प्रमाणीकरण प्रमाणहरू प्रदान गर्नुहोस् ( ), वा एक प्रमाणीकरण टोकन (अतिरिक्त जानकारीको लागि टोकन प्रमाणीकरण हेर्नुहोस्)।
- लक्षित अनुरोध ठेगाना: https://<asa management ipaddress>/api/objects/networkobjects
- शारीरिक सामग्री प्रकार: application/json
अपरेशनको कच्चा शरीर:
तपाईं अब ASA कन्फिगर र निगरानी गर्न ASA REST API प्रयोग गर्न सक्नुहुन्छ। कल विवरण र पूर्वका लागि API कागजातहरू सन्दर्भ गर्नुहोस्ampलेस।
ब्याक-अप कन्फिगरेसन पूर्ण रूपमा पुनर्स्थापित गर्ने बारे
REST API प्रयोग गरेर ASA मा पूर्ण ब्याक-अप कन्फिगरेसन पुनर्स्थापना गर्दा ASA पुन: लोड हुनेछ। यसबाट बच्न, ब्याक-अप कन्फिगरेसन पुनर्स्थापना गर्न निम्न आदेश प्रयोग गर्नुहोस्:
- {
- "आदेशहरू":["प्रतिलिपि /noconfirm disk0:/fileनाम> चलिरहेको कन्फिगरेसन"]
- }
- कहाँfilename> backup.cfg हो वा कन्फिगरेसन ब्याकअप गर्दा तपाईंले प्रयोग गर्नुभएको जुनसुकै नाम हो।
कागजात कन्सोल र निर्यात API लिपिहरू
तपाइँ पनि REST API अन-लाइन कागजात कन्सोल प्रयोग गर्न सक्नुहुन्छ ("कागजात UI" को रूपमा उल्लेख गरिएको), होस्टमा उपलब्ध छ: port/doc/ "sandbox" को रूपमा ASA मा API कलहरू सिधै सिक्न र प्रयास गर्नको लागि। यसबाहेक, तपाईंले कागजात UI मा निर्यात अपरेशन बटन प्रयोग गर्न सक्नुहुन्छ प्रदर्शित विधि बचत गर्न पूर्वample जाभास्क्रिप्ट, पाइथन, वा पर्ल लिपिको रूपमा file तपाईंको स्थानीय होस्टमा। त्यसपछि तपाइँ यो लिपि तपाइँको ASA मा लागू गर्न सक्नुहुन्छ, र अन्य ASA र अन्य नेटवर्क उपकरणहरूमा अनुप्रयोगको लागि सम्पादन गर्न सक्नुहुन्छ। यसको अर्थ मुख्य रूपमा शैक्षिक र बुटस्ट्र्यापिङ उपकरणको रूपमा थियो।
जाभास्क्रिप्ट
- जाभास्क्रिप्ट प्रयोग गर्दै file node.js को स्थापना आवश्यक छ, जुन मा फेला पार्न सकिन्छ http://nodejs.org/.
- node.js प्रयोग गरेर, तपाइँ जाभास्क्रिप्ट कार्यान्वयन गर्न सक्नुहुन्छ file, सामान्यतया ब्राउजरको लागि लेखिएको, जस्तै कमाण्ड-लाइन लिपि। बस स्थापना निर्देशनहरू पालना गर्नुहोस्, र त्यसपछि नोड script.js को साथ आफ्नो स्क्रिप्ट चलाउनुहोस्।
पाइथन
- पाइथन स्क्रिप्टहरूले तपाईंलाई पाइथन स्थापना गर्न आवश्यक छ, बाट उपलब्ध छ https://www.python.org/.
- एकपटक तपाईंले पाइथन स्थापना गरिसकेपछि, तपाईंले python script.py प्रयोगकर्ता नाम पासवर्डको साथ आफ्नो स्क्रिप्ट चलाउन सक्नुहुन्छ।
पर्ल
पर्ल स्क्रिप्टहरू प्रयोग गर्नका लागि केही अतिरिक्त सेट-अप चाहिन्छ - तपाईंलाई पाँचवटा कम्पोनेन्टहरू चाहिन्छ: पर्ल आफैं, र चार पर्ल पुस्तकालयहरू:
- पर्ल प्याकेज, मा फेला पर्यो http://www.perl.org/
- बन्डल::CPAN, http://search.cpan.org/~andk/Bundle-CPAN-1.861/CPAN.pm मा फेला पर्यो
- आराम::ग्राहक, मा भेटियो http://search.cpan.org/~mcrawfor/REST-Client-88/lib/REST/Client.pm
- MIME::Base64, मा फेला पर्यो http://perldoc.perl.org/MIME/Base64.html
- JSON, मा फेला पर्यो http://search.cpan.org/~makamaka/JSON-2.90/lib/JSON.pm
यहाँ एक पूर्व छampMacintosh मा बुटस्ट्र्यापिंग पर्ल को le:
- $ sudo perl -MCPAN e shell
- cpan> बन्डल स्थापना गर्नुहोस्::CPAN
- cpan> REST स्थापना गर्नुहोस्:: ग्राहक
- cpan> MIME स्थापना गर्नुहोस्:: आधार ६४
- cpan> JSON स्थापना गर्नुहोस्
निर्भरताहरू स्थापना गरेपछि, तपाईंले perl script.pl प्रयोगकर्ता नाम पासवर्ड प्रयोग गरेर आफ्नो स्क्रिप्ट चलाउन सक्नुहुन्छ।
ASA मा REST API डिबगिङ सक्षम गर्दै
यदि तपाइँलाई ASA मा REST API कन्फिगर गर्न वा जडान गर्न समस्या भइरहेको छ भने, तपाइँ तपाइँको कन्सोलमा डिबगिङ सन्देशहरूको प्रदर्शन सक्षम गर्न निम्न CLI आदेश प्रयोग गर्न सक्नुहुन्छ। डिबग सन्देशहरू असक्षम गर्न आदेशको कुनै फारम प्रयोग नगर्नुहोस्।
डिबग rest-api [एजेन्ट | cli | ग्राहक | डेमन | प्रक्रिया | token-auth] [त्रुटि | घटना] कुनै डिबग विश्राम-एपीआई छैन
वाक्य रचना विवरण
- एजेन्ट: (वैकल्पिक) REST API एजेन्ट डिबगिङ जानकारी सक्षम गर्नुहोस्।
- cli: (वैकल्पिक) REST API CLI डेमन-टू-एजेन्ट संचारका लागि डिबगिङ सन्देशहरू सक्षम गर्नुहोस्।
- ग्राहक: (वैकल्पिक) REST API क्लाइन्ट र REST API एजेन्ट बीच सन्देश राउटिङको लागि डिबगिङ जानकारी सक्षम गर्नुहोस्।
- डेमन: (वैकल्पिक) REST API डेमन-टू-एजेन्ट संचारका लागि डिबगिङ सन्देशहरू सक्षम गर्नुहोस्।
- प्रक्रिया: (वैकल्पिक) REST API एजेन्ट प्रक्रिया सुरु/रोक डिबगिङ जानकारी सक्षम गर्नुहोस्।
- टोकन प्रमाणीकरण: (वैकल्पिक) REST API टोकन प्रमाणीकरण डिबगिङ जानकारी।
- त्रुटि: (वैकल्पिक) डिबग सन्देशहरूलाई API द्वारा लग गरिएका त्रुटिहरूमा मात्र सीमित गर्न यो कुञ्जी शब्द प्रयोग गर्नुहोस्।
- घटना: (वैकल्पिक) API द्वारा लग गरिएका घटनाहरूमा डिबग सन्देशहरू सीमित गर्न यो कुञ्जी शब्द प्रयोग गर्नुहोस्।
उपयोग दिशानिर्देश
यदि तपाइँ एक विशेष कम्पोनेन्ट कुञ्जी शब्द प्रदान गर्नुभएन भने (त्यो हो, यदि तपाइँ केवल आदेश debug rest-api जारी गर्नुहुन्छ), डिबग सन्देशहरू सबै कम्पोनेन्ट प्रकारका लागि प्रदर्शित हुन्छन्। यदि तपाइँ घटना वा त्रुटि कुञ्जी शब्द प्रदान गर्नुहुन्न भने, घटना र त्रुटि सन्देशहरू निर्दिष्ट कम्पोनेन्टका लागि प्रदर्शित हुन्छन्। पूर्वका लागिample, debug rest-api deemon घटनाले API Daemon-to-Agent संचारका लागि घटना डिबग सन्देशहरू मात्र देखाउनेछ।
सम्बन्धित आदेशहरू
आदेश / विवरण
- डिबग HTTP; यो आदेश प्रयोग गर्नुहोस् view HTTP ट्राफिक बारे विस्तृत जानकारी।
ASA REST API-सम्बन्धित प्रणाली-लग सन्देशहरू यस खण्डमा वर्णन गरिएको छ।
342001
- त्रुटि सन्देश: %ASA-7-342001: REST API एजेन्ट सफलतापूर्वक सुरु भयो।
- व्याख्या: REST API ग्राहकले ASA कन्फिगर गर्न सक्नु अघि REST API एजेन्ट सफलतापूर्वक सुरु गरिनुपर्छ।
- सिफारिस गरिएको कारबाही: कुनै पनि छैन।
342002
- त्रुटि सन्देश: %ASA-3-342002: REST API एजेन्ट असफल भयो, कारण: कारण
- व्याख्या: REST API एजेन्ट विभिन्न कारणहरूका लागि सुरु वा क्र्यास गर्न असफल हुन सक्छ, र कारण निर्दिष्ट गरिएको छ।
- कारण - REST API विफलताको कारण
सिफारिस गरिएको कारबाही: समस्या समाधान गर्नका लागि गरिएका कार्यहरू लगइन गरिएको कारणको आधारमा भिन्न हुन्छन्। पूर्वका लागिampले, जाभा प्रक्रिया मेमोरी समाप्त हुँदा REST API एजेन्ट क्र्यास हुन्छ। यदि यो हुन्छ भने, तपाईंले REST API एजेन्ट पुन: सुरु गर्न आवश्यक छ। यदि पुन: सुरुवात सफल भएन भने, सिस्को TAC लाई सम्पर्क गर्नुहोस् मूल कारण समाधान पहिचान गर्न।
342003
- त्रुटि सन्देश: %ASA-3-342003: REST API एजेन्ट विफलता सूचना प्राप्त भयो। एजेन्ट स्वतः पुन: सुरु हुनेछ।
- व्याख्या: REST API एजेन्टबाट असफलताको सूचना प्राप्त भएको छ र एजेन्टको पुन: सुरु गर्ने प्रयास भइरहेको छ।
- सिफारिस गरिएको कारबाही: कुनै पनि छैन।
342004
- त्रुटि सन्देश: %ASA-3-342004: 5 असफल प्रयास पछि REST API एजेन्ट स्वतः पुन: सुरु गर्न असफल। म्यानुअल रूपमा एजेन्ट पुन: सुरु गर्न 'नो रेस्ट-एपीआई एजेन्ट' र 'रेस्ट-एपीआई एजेन्ट' आदेशहरू प्रयोग गर्नुहोस्।
- व्याख्या: REST API एजेन्ट धेरै प्रयास पछि सुरु गर्न असफल भएको छ।
- सिफारिस गरिएको कारबाही: असफलताको कारण राम्रोसँग बुझ्नको लागि syslog % ASA-3-342002 (यदि लग गरिएको छ) हेर्नुहोस्। No rest-api एजेन्ट आदेश प्रविष्ट गरेर REST API एजेन्ट असक्षम गर्ने प्रयास गर्नुहोस् र rest-api एजेन्ट आदेश प्रयोग गरेर REST API एजेन्टलाई पुन: सक्षम गर्नुहोस्।
ASA, र यसको कन्फिगरेसन र व्यवस्थापन बारे थप जानकारी पाउनको लागि निम्न लिङ्क प्रयोग गर्नुहोस्:
- सिस्को ASA श्रृंखला कागजात नेभिगेट गर्दै: http://www.cisco.com/go/asadocs
- निम्न लिङ्क प्रयोग गर्नुहोस् view ASA सुविधाहरूको सूची ASAv मा समर्थित छैन: http://www.cisco.com/c/en/us/td/docs/security/asa/asa92/configuration/general/asa-general-cli/introasav.html#pgfId-1156883
यो कागजात "सम्बन्धित कागजात" खण्डबाट उपलब्ध कागजातहरूसँग संयोजनमा प्रयोग गरिने छ।
Cisco र Cisco लोगो संयुक्त राज्य अमेरिका र अन्य देशहरूमा Cisco र/वा यसका सम्बद्ध कम्पनीहरूको ट्रेडमार्क वा दर्ता गरिएका ट्रेडमार्कहरू हुन्। को view सिस्को ट्रेडमार्कहरूको सूची, यसमा जानुहोस् URL: www.cisco.com/go/trademarks। उल्लिखित तेस्रो-पक्ष ट्रेडमार्कहरू तिनीहरूका सम्बन्धित मालिकहरूको सम्पत्ति हुन्। साझेदार शब्दको प्रयोगले Cisco र कुनै अन्य कम्पनी बीचको साझेदारी सम्बन्धलाई संकेत गर्दैन। (१११० आर)
यस कागजातमा प्रयोग गरिएका कुनै पनि इन्टरनेट प्रोटोकल (IP) ठेगानाहरू र फोन नम्बरहरू वास्तविक ठेगानाहरू र फोन नम्बरहरू हुनको लागि होइन। कुनै पनि पूर्वamples, कमाण्ड डिस्प्ले आउटपुट, नेटवर्क टोपोलोजी रेखाचित्र, र कागजातमा समावेश अन्य तथ्याङ्कहरू चित्रण उद्देश्यका लागि मात्र देखाइन्छ।
उदाहरणीय सामग्रीमा वास्तविक आईपी ठेगाना वा फोन नम्बरहरूको कुनै पनि प्रयोग अनावश्यक र संयोग हो।
सिस्को सिस्टम्स, इंक।
© 2014-2018 Cisco Systems, Inc. सबै अधिकार सुरक्षित।
कागजातहरू / स्रोतहरू
![]() |
CISCO ASA REST API एप [pdf] प्रयोगकर्ता गाइड ASA REST API अनुप्रयोग, ASA, REST API अनुप्रयोग, API अनुप्रयोग, अनुप्रयोग |