CISCO ASA REST API యాప్

సూచనలను ఉపయోగించి ఉత్పత్తి

పైగాview

Cisco యొక్క ASA REST API విడుదలతో, మీరు ఇప్పుడు వ్యక్తిగత Cisco ASAలను కాన్ఫిగర్ చేయడానికి మరియు నిర్వహించడానికి మరొక తేలికైన, ఉపయోగించడానికి సులభమైన ఎంపికను కలిగి ఉన్నారు. ASA REST API అనేది RESTful సూత్రాలపై ఆధారపడిన అప్లికేషన్ ప్రోగ్రామింగ్ ఇంటర్‌ఫేస్ (API). API అమలులో ఉన్న ఏదైనా ASAలో ఇది త్వరగా డౌన్‌లోడ్ చేయబడుతుంది మరియు ప్రారంభించబడుతుంది. సిస్కో సిస్టమ్స్, ఇంక్.

www.cisco.com

ASA REST API అభ్యర్థనలు మరియు ప్రతిస్పందనలు

మీ బ్రౌజర్‌లో REST క్లయింట్‌ను ఇన్‌స్టాల్ చేసిన తర్వాత, మీరు నిర్దిష్ట ASA యొక్క REST ఏజెంట్‌ని సంప్రదించవచ్చు మరియు ప్రస్తుత కాన్ఫిగరేషన్ సమాచారాన్ని యాక్సెస్ చేయడానికి మరియు అదనపు కాన్ఫిగరేషన్ పారామితులను జారీ చేయడానికి ప్రామాణిక HTTP పద్ధతులను ఉపయోగించవచ్చు.

జాగ్రత్త: ASAలో REST API ప్రారంభించబడినప్పుడు, ఇతర భద్రతా నిర్వహణ ప్రోటోకాల్‌ల ద్వారా కనెక్షన్‌లు బ్లాక్ చేయబడవు. మీరు అదే చేస్తున్నప్పుడు CLI, ASDM లేదా సెక్యూరిటీ మేనేజర్‌ని ఉపయోగించే ఇతరులు ASA కాన్ఫిగరేషన్‌ను మార్చవచ్చని దీని అర్థం.

అభ్యర్థన నిర్మాణం

ASA REST API మీకు ప్రాతినిధ్య రాష్ట్ర బదిలీ (REST)API ద్వారా వ్యక్తిగత ASAలను నిర్వహించడానికి ప్రోగ్రామాటిక్ యాక్సెస్‌ను అందిస్తుంది. API బాహ్య క్లయింట్‌లను ASA వనరులపై CRUD (సృష్టించండి, చదవండి, నవీకరించండి, తొలగించండి) కార్యకలాపాలను నిర్వహించడానికి అనుమతిస్తుంది. అన్ని API అభ్యర్థనలు HTTPS ద్వారా ASAకి పంపబడతాయి మరియు ప్రతిస్పందన అందించబడుతుంది.

వస్తువు లక్షణాలు ఎక్కడ ఉన్నాయి:

ఆస్తి	టైప్ చేయండి	వివరణ
సందేశాలు	నిఘంటువుల జాబితా	లోపం లేదా హెచ్చరిక సందేశాల జాబితా
కోడ్	స్ట్రింగ్	లోపం/హెచ్చరిక/సమాచారానికి సంబంధించిన వివరణాత్మక సందేశం
వివరాలు	స్ట్రింగ్	లోపం/హెచ్చరిక/సమాచారానికి సంబంధించిన వివరణాత్మక సందేశం

గమనిక: REST API కాల్‌ల ద్వారా చేసిన మార్పులు స్టార్టప్ కాన్ఫిగరేషన్‌కు కొనసాగించబడవు కానీ నడుస్తున్న కాన్ఫిగరేషన్‌కు మాత్రమే కేటాయించబడతాయి. స్టార్టప్ కాన్ఫిగరేషన్‌లో మార్పులను సేవ్ చేయడానికి, మీరు పోస్ట్ ఎ రైట్ మెమ్ API అభ్యర్థనను ఉపయోగించవచ్చు. మరింత సమాచారం కోసం, ASA REST API విషయాల పట్టికలో వ్రాసే మెమరీ API ఎంట్రీని చూడండి.

ASA REST API ఏజెంట్ మరియు క్లయింట్‌ను ఇన్‌స్టాల్ చేయండి మరియు కాన్ఫిగర్ చేయండి

గమనిక: REST API ఏజెంట్ జావా-ఆధారిత అప్లికేషన్. జావా రన్‌టైమ్ ఎన్విరాన్‌మెంట్ (JRE) REST API ఏజెంట్ ప్యాకేజీలో బండిల్ చేయబడింది.

పైగాview

వ్యక్తిగత సిస్కో ASAలను కాన్ఫిగర్ చేయడానికి మరియు నిర్వహించడానికి అనేక ఎంపికలు అందుబాటులో ఉన్నాయి:

• కమాండ్ లైన్ ఇంటర్‌ఫేస్ (CLI) - మీరు కనెక్ట్ చేయబడిన కన్సోల్ ద్వారా ASAకి నేరుగా నియంత్రణ ఆదేశాలను పంపుతారు.
• అడాప్టివ్ సెక్యూరిటీ డివైస్ మేనేజర్ (ASDM) – మీరు ASAని కాన్ఫిగర్ చేయడానికి, మేనేజ్ చేయడానికి మరియు పర్యవేక్షించడానికి ఉపయోగించే గ్రాఫికల్ యూజర్ ఇంటర్‌ఫేస్‌తో కూడిన “ఆన్-బాక్స్” మేనేజ్‌మెంట్ అప్లికేషన్.
• సిస్కో సెక్యూరిటీ మేనేజర్ - అనేక భద్రతా పరికరాల మధ్యస్థం నుండి పెద్ద నెట్‌వర్క్‌ల కోసం ఉద్దేశించబడినప్పటికీ, ఈ గ్రాఫికల్ అప్లికేషన్ వ్యక్తిగత ASAలను కాన్ఫిగర్ చేయడానికి, నిర్వహించడానికి మరియు పర్యవేక్షించడానికి ఉపయోగించవచ్చు.

Cisco యొక్క ASA REST API విడుదలతో, మీరు ఇప్పుడు మరొక తేలికైన, ఉపయోగించడానికి సులభమైన ఎంపికను కలిగి ఉన్నారు. ఇది "RESTful" సూత్రాల ఆధారంగా ఒక అప్లికేషన్ ప్రోగ్రామింగ్ ఇంటర్‌ఫేస్ (API), మీరు API రన్ అవుతున్న ఏదైనా ASAలో త్వరగా డౌన్‌లోడ్ చేసుకోవచ్చు మరియు ప్రారంభించవచ్చు.

మీ బ్రౌజర్‌లో REST క్లయింట్‌ను ఇన్‌స్టాల్ చేసిన తర్వాత, మీరు నిర్దిష్ట ASA యొక్క REST ఏజెంట్‌ని సంప్రదించవచ్చు మరియు ప్రస్తుత కాన్ఫిగరేషన్ సమాచారాన్ని యాక్సెస్ చేయడానికి మరియు అదనపు కాన్ఫిగరేషన్ పారామితులను జారీ చేయడానికి ప్రామాణిక HTTP పద్ధతులను ఉపయోగించవచ్చు.

జాగ్రత్త: ASAలో REST API ప్రారంభించబడినప్పుడు, ఇతర భద్రతా నిర్వహణ ప్రోటోకాల్‌ల ద్వారా కనెక్షన్‌లు బ్లాక్ చేయబడవు. మీరు అదే చేస్తున్నప్పుడు CLI, ASDM లేదా సెక్యూరిటీ మేనేజర్‌ని ఉపయోగించే ఇతరులు ASA కాన్ఫిగరేషన్‌ను మార్చవచ్చని దీని అర్థం.

ASA REST API అభ్యర్థనలు మరియు ప్రతిస్పందనలు

ASA REST API మీకు ప్రాతినిధ్య రాష్ట్ర బదిలీ (REST) ​​API ద్వారా వ్యక్తిగత ASAలను నిర్వహించడానికి ప్రోగ్రామాటిక్ యాక్సెస్‌ను అందిస్తుంది. API బాహ్య క్లయింట్‌లను ASA వనరులపై CRUD (సృష్టించడం, చదవడం, నవీకరించడం, తొలగించడం) కార్యకలాపాలను నిర్వహించడానికి అనుమతిస్తుంది; ఇది HTTPS ప్రోటోకాల్ మరియు REST మెథడాలజీపై ఆధారపడి ఉంటుంది. అన్ని API అభ్యర్థనలు HTTPS ద్వారా ASAకి పంపబడతాయి మరియు ప్రతిస్పందన అందించబడుతుంది. ఈ విభాగం ఓవర్‌ను అందిస్తుందిview అభ్యర్థనలు ఎలా నిర్మించబడ్డాయి మరియు ఆశించిన ప్రతిస్పందనలు,

అభ్యర్థన నిర్మాణం

అందుబాటులో ఉన్న అభ్యర్థన పద్ధతులు:

• GET - పేర్కొన్న వస్తువు నుండి డేటాను తిరిగి పొందుతుంది.
• PUT - పేర్కొన్న వస్తువుకు సరఫరా చేయబడిన సమాచారాన్ని జోడిస్తుంది; ఆబ్జెక్ట్ లేనట్లయితే 404 రిసోర్స్ నాట్ ఫౌండ్ ఎర్రర్‌ను అందిస్తుంది.
• పోస్ట్ - సరఫరా చేయబడిన సమాచారంతో వస్తువును సృష్టిస్తుంది.
• తొలగించు - పేర్కొన్న వస్తువును తొలగిస్తుంది.
• ప్యాచ్ - పేర్కొన్న వస్తువుకు పాక్షిక మార్పులను వర్తింపజేస్తుంది.

ప్రతిస్పందన నిర్మాణం

• ప్రతి అభ్యర్థన ప్రామాణిక శీర్షికలు, ప్రతిస్పందన కంటెంట్ మరియు స్థితి కోడ్‌తో ASA నుండి HTTPS ప్రతిస్పందనను ఉత్పత్తి చేస్తుంది.

ప్రతిస్పందన నిర్మాణం కావచ్చు:

• స్థానం - కొత్తగా సృష్టించబడిన వనరు ID; POST కోసం మాత్రమే-కొత్త వనరు IDని కలిగి ఉంటుంది (URI ప్రాతినిధ్యంగా).
• కంటెంట్-రకం - ప్రతిస్పందన సందేశాన్ని వివరించే మీడియా రకం; ప్రతిస్పందన సందేశం యొక్క ప్రాతినిధ్యాన్ని మరియు వాక్యనిర్మాణాన్ని వివరిస్తుంది.

ప్రతి ప్రతిస్పందనలో HTTP స్థితి లేదా ఎర్రర్ కోడ్ ఉంటుంది. అందుబాటులో ఉన్న కోడ్‌లు ఈ వర్గాలలోకి వస్తాయి:

• 20x - రెండు వందల శ్రేణి కోడ్ విజయవంతమైన ఆపరేషన్‌ను సూచిస్తుంది, వీటిలో:
  • 200 సరే - విజయవంతమైన అభ్యర్థనలకు ప్రామాణిక ప్రతిస్పందన.
  • 201 సృష్టించబడింది - అభ్యర్థన పూర్తయింది; కొత్త వనరు సృష్టించబడింది.
  • 202 ఆమోదించబడింది - అభ్యర్థన ఆమోదించబడింది, కానీ ప్రాసెసింగ్ పూర్తి కాలేదు.
  • 204 కంటెంట్ లేదు - సర్వర్ విజయవంతంగా అభ్యర్థనను ప్రాసెస్ చేసింది; ఏ కంటెంట్ తిరిగి ఇవ్వబడదు.
• 4xx – నాలుగు వందల సిరీస్ కోడ్ క్లయింట్ వైపు లోపాన్ని సూచిస్తుంది, వీటిలో:
  • 400 తప్పు అభ్యర్థన – గుర్తించబడని పారామీటర్‌లు, తప్పిపోయిన పారామీటర్‌లు లేదా చెల్లని విలువలతో సహా చెల్లని ప్రశ్న పారామీటర్‌లు.
  • 404 కనుగొనబడలేదు - అందించినది URL ఇప్పటికే ఉన్న వనరుతో సరిపోలడం లేదు. ఉదాహరణకుample, వనరు అందుబాటులో లేనందున HTTP తొలగింపు విఫలం కావచ్చు.
  • 405 పద్ధతి అనుమతించబడలేదు - వనరుపై అనుమతించబడని HTTP అభ్యర్థన సమర్పించబడింది; ఉదాహరణకుample, చదవడానికి-మాత్రమే వనరుపై ఒక POST.
• 5xx – ఐదు వందల సిరీస్ కోడ్ సర్వర్ వైపు లోపాన్ని సూచిస్తుంది.

ఎర్రర్ విషయంలో, ఎర్రర్ కోడ్‌తో పాటు, రిటర్న్ రెస్పాన్స్‌లో ఎర్రర్ గురించి మరిన్ని వివరాలను కలిగి ఉండే ఎర్రర్ ఆబ్జెక్ట్ ఉండవచ్చు. JSON లోపం/హెచ్చరిక ప్రతిస్పందన స్కీమా క్రింది విధంగా ఉంది:

వస్తువు లక్షణాలు ఎక్కడ ఉన్నాయి:

ఆస్తి	టైప్ చేయండి	వివరణ
సందేశాలు	నిఘంటువుల జాబితా	లోపం లేదా హెచ్చరిక సందేశాల జాబితా
కోడ్	స్ట్రింగ్	లోపం/హెచ్చరిక/సమాచార కోడ్
వివరాలు	స్ట్రింగ్	లోపం/హెచ్చరిక/సమాచారానికి సంబంధించిన వివరణాత్మక సందేశం

గమనిక: REST API కాల్‌ల ద్వారా చేసిన ASA కాన్ఫిగరేషన్‌లో మార్పులు స్టార్టప్ కాన్ఫిగరేషన్‌కు కొనసాగించబడవు; అంటే, రన్నింగ్ కాన్ఫిగరేషన్‌కు మాత్రమే మార్పులు కేటాయించబడతాయి. ప్రారంభ కాన్ఫిగరేషన్‌లో మార్పులను సేవ్ చేయడానికి, మీరు రైట్‌మెమ్ API అభ్యర్థనను పోస్ట్ చేయవచ్చు; మరింత సమాచారం కోసం, ASA REST API విషయాల పట్టికలో “వ్రైట్ మెమరీ API” ఎంట్రీని అనుసరించండి.

ASA REST API ఏజెంట్ మరియు క్లయింట్‌ను ఇన్‌స్టాల్ చేయండి మరియు కాన్ఫిగర్ చేయండి

• REST API ఏజెంట్ ఇతర ASA చిత్రాలతో వ్యక్తిగతంగా ప్రచురించబడుతుంది cisco.com. భౌతిక ASAల కోసం, REST API ప్యాకేజీ తప్పనిసరిగా పరికరం యొక్క ఫ్లాష్‌కి డౌన్‌లోడ్ చేయబడాలి మరియు “rest-api ఇమేజ్” ఆదేశాన్ని ఉపయోగించి ఇన్‌స్టాల్ చేయాలి. REST API ఏజెంట్ “rest-api agent” ఆదేశాన్ని ఉపయోగించి ప్రారంభించబడుతుంది.
• వర్చువల్ ASA (ASAv)తో, REST API ఇమేజ్ తప్పనిసరిగా “boot:” విభజనకు డౌన్‌లోడ్ చేయబడాలి. మీరు REST API ఏజెంట్‌ను యాక్సెస్ చేయడానికి మరియు ఎనేబుల్ చేయడానికి "rest-api ఇమేజ్" కమాండ్‌ను తప్పనిసరిగా జారీ చేయాలి, ఆ తర్వాత "rest-api ఏజెంట్" ఆదేశాన్ని అందించాలి.
• REST API సాఫ్ట్‌వేర్ మరియు హార్డ్‌వేర్ అవసరాలు మరియు అనుకూలత గురించి సమాచారం కోసం, Cisco ASA అనుకూలత మాతృకను చూడండి.
• మీరు మీ ASA లేదా ASAv కోసం తగిన REST API ప్యాకేజీని డౌన్‌లోడ్ చేసుకోవచ్చు software.cisco.com/download/home. నిర్దిష్ట అడాప్టివ్ సెక్యూరిటీ అప్లయన్సెస్ (ASA) మోడల్‌ను గుర్తించి, ఆపై అడాప్టివ్ సెక్యూరిటీ అప్లయన్స్ REST API ప్లగిన్‌ని ఎంచుకోండి.

గమనిక: REST API ఏజెంట్ జావా-ఆధారిత అప్లికేషన్. జావా రన్‌టైమ్ ఎన్విరాన్‌మెంట్ (JRE) REST API ఏజెంట్ ప్యాకేజీలో బండిల్ చేయబడింది.

వినియోగ మార్గదర్శకాలు

ముఖ్యమైనది మీరు తప్పనిసరిగా అన్ని API కాల్‌లు మరియు ఇప్పటికే ఉన్న స్క్రిప్ట్‌లలో వినియోగదారు-ఏజెంట్: REST API ఏజెంట్ అనే హెడర్‌ను తప్పనిసరిగా చేర్చాలి. C కోసం -H 'యూజర్-ఏజెంట్: REST API ఏజెంట్' ఉపయోగించండిURL ఆదేశం. బహుళ-సందర్భ మోడ్‌లో, REST API ఏజెంట్ ఆదేశాలు సిస్టమ్ సందర్భంలో మాత్రమే అందుబాటులో ఉంటాయి.

గరిష్ట మద్దతు గల కాన్ఫిగరేషన్ పరిమాణం

ASA రెస్ట్ API అనేది భౌతిక ASA లోపల అమలవుతున్న “ఆన్-బోర్డ్” అప్లికేషన్, మరియు దానికి కేటాయించిన మెమరీపై పరిమితి ఉంటుంది. 2 మరియు 5555 వంటి ఇటీవలి ప్లాట్‌ఫారమ్‌లలో గరిష్ట మద్దతు ఉన్న రన్నింగ్ కాన్ఫిగరేషన్ పరిమాణం విడుదల చక్రంలో సుమారు 5585 MBకి పెరిగింది. ASA రెస్ట్ 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లో ASA REST API ఏజెంట్‌ని డౌన్‌లోడ్ చేసి, ఇన్‌స్టాల్ చేయడానికి ఈ దశలను అనుసరించండి:

• దశ 1: కావలసిన ASAలో, కాపీని జారీ చేయండి disk0: ప్రస్తుత ASA REST API ప్యాకేజీని డౌన్‌లోడ్ చేయడానికి ఆదేశం cisco.com ASA యొక్క ఫ్లాష్ మెమరీకి.
  • ఉదాహరణకుampలే: కాపీ tftp://10.7.0.80/asa-restapi-111-lfbff-k8.SPA disk0:
• దశ 2: రెస్ట్-ఎపి ఇమేజ్ డిస్క్0:/ని జారీ చేయండి ప్యాకేజీని ధృవీకరించడానికి మరియు ఇన్‌స్టాల్ చేయడానికి ఆదేశం.
  • ఉదాహరణకుampలే: rest-api ఇమేజ్ డిస్క్0:/asa-restapi-111-lfbff-k8.SPA

ఇన్‌స్టాలర్ అనుకూలత మరియు ధ్రువీకరణ తనిఖీలను నిర్వహిస్తుంది, ఆపై ప్యాకేజీని ఇన్‌స్టాల్ చేస్తుంది. ASA రీబూట్ చేయదు.

REST API ఏజెంట్‌ని ప్రారంభించండి

నిర్దిష్ట ASAలో ASA REST API ఏజెంట్‌ని ప్రారంభించడానికి ఈ దశలను అనుసరించండి:

• దశ 1: ASAలో సరైన సాఫ్ట్‌వేర్ ఇమేజ్ ఇన్‌స్టాల్ చేయబడిందని నిర్ధారించుకోండి.
  • ASA అనుకూలత మాతృక యొక్క REST API విభాగాన్ని సంప్రదించండి (https://www.cisco.com/c/en/us/td/docs/security/asa/compatibility/asamatrx.html#pgfId-131643) ఏ ASA ఇమేజ్ అవసరమో నిర్ణయించడానికి.
• దశ 2: CLIని ఉపయోగించి, ASAలో HTTP సర్వర్ ప్రారంభించబడిందని మరియు API క్లయింట్లు మేనేజ్‌మెంట్ ఇంటర్‌ఫేస్‌కు కనెక్ట్ చేయగలరని నిర్ధారించుకోండి.
  • ఉదాహరణకుampలే: http సర్వర్ ప్రారంభించండి
  • http 0.0.0.0 0.0.0.0
• దశ 3: CLIని ఉపయోగించి, API కనెక్షన్‌ల కోసం HTTP ప్రమాణీకరణను నిర్వచించండి. ఉదాహరణకుample: aaa ప్రమాణీకరణ http కన్సోల్ LOCAL
• దశ 4: CLIని ఉపయోగించి, API ట్రాఫిక్ కోసం ASAలో స్థిరమైన మార్గాన్ని సృష్టించండి. ఉదాహరణకుample: మార్గం 0.0.0.0 0.0.0.0 1
• దశ 5: 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 క్లయింట్‌ను ఇన్‌స్టాల్ చేయడానికి మరియు కాన్ఫిగర్ చేయడానికి ఈ దశలను అనుసరించండి:

• దశ 1: మీ బ్రౌజర్ కోసం REST API క్లయింట్‌ని పొందండి మరియు ఇన్‌స్టాల్ చేయండి.
  • Chrome కోసం, Google నుండి REST క్లయింట్‌ని ఇన్‌స్టాల్ చేయండి. Firefox కోసం, RESTClient యాడ్-ఆన్‌ని ఇన్‌స్టాల్ చేయండి. Internet Explorerకు మద్దతు లేదు.
• దశ 2: మీ బ్రౌజర్‌ని ఉపయోగించి కింది అభ్యర్థనను ప్రారంభించండి: https: /api/objects/networkobjects
  • మీరు ఎర్రర్ లేని ప్రతిస్పందనను స్వీకరిస్తే, మీరు ASAలో పనిచేస్తున్న REST API ఏజెంట్‌కి చేరుకున్నారు.
  • మీకు ఏజెంట్ అభ్యర్థనతో సమస్యలు ఉన్నట్లయితే, ASAలో REST API డీబగ్గింగ్‌ను ప్రారంభించడంలో వివరించిన విధంగా, మీరు CLI కన్సోల్‌లో డీబగ్గింగ్ సమాచారం యొక్క ప్రదర్శనను ప్రారంభించవచ్చు.
• దశ 3: ఐచ్ఛికంగా, మీరు POST ఆపరేషన్ చేయడం ద్వారా ASAకి మీ కనెక్షన్‌ని పరీక్షించవచ్చు.

ఉదాహరణకుampలే: ప్రాథమిక అధికార ఆధారాలను అందించండి ( ), లేదా ప్రమాణీకరణ టోకెన్ (అదనపు సమాచారం కోసం టోకెన్ ప్రమాణీకరణను చూడండి).

• లక్ష్య అభ్యర్థన చిరునామా: https://<asa management ipaddress>/api/objects/networkobjects
• శరీర కంటెంట్ రకం: అప్లికేషన్/json

ఆపరేషన్ యొక్క ముడి శరీరం:

ASAని కాన్ఫిగర్ చేయడానికి మరియు పర్యవేక్షించడానికి మీరు ఇప్పుడు ASA REST APIని ఉపయోగించవచ్చు. కాల్ వివరణల కోసం API డాక్యుమెంటేషన్‌ని చూడండి మరియు ఉదాampలెస్.

బ్యాకప్ కాన్ఫిగరేషన్‌ను పూర్తిగా పునరుద్ధరించడం గురించి

REST APIని ఉపయోగించి ASAలో పూర్తి బ్యాకప్ కాన్ఫిగరేషన్‌ని పునరుద్ధరించడం ASAని రీలోడ్ చేస్తుంది. దీన్ని నివారించడానికి, బ్యాకప్ కాన్ఫిగరేషన్‌ను పునరుద్ధరించడానికి కింది ఆదేశాన్ని ఉపయోగించండి:

• {
  • “కమాండ్స్”:[“copy /noconfirm disk0:/fileపేరు> నడుస్తున్న-కాన్ఫిగరేషన్"]
• }
  • ఎక్కడfilename> అనేది backup.cfg లేదా కాన్ఫిగరేషన్‌ను బ్యాకప్ చేసేటప్పుడు మీరు ఉపయోగించిన పేరు.

డాక్యుమెంటేషన్ కన్సోల్ మరియు API స్క్రిప్ట్‌లను ఎగుమతి చేస్తోంది

ASAలో నేరుగా API కాల్‌ల గురించి తెలుసుకోవడానికి మరియు ప్రయత్నించడానికి మీరు హోస్ట్:port/doc/ వద్ద అందుబాటులో ఉన్న REST 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

ఇక్కడ ఒక మాజీampమ్యాకింతోష్‌లో పెర్ల్‌ను బూట్‌స్ట్రాప్ చేయడం:

• $ సుడో పెర్ల్ -MCPAN ఇ షెల్
• cpan> బండిల్‌ని ఇన్‌స్టాల్ చేయండి::CPAN
• cpan> RESTని ఇన్‌స్టాల్ చేయండి:: క్లయింట్
• cpan> MIMEని ఇన్‌స్టాల్ చేయండి::బేస్ 64
• cpan> JSONని ఇన్‌స్టాల్ చేయండి

డిపెండెన్సీలను ఇన్‌స్టాల్ చేసిన తర్వాత, మీరు మీ స్క్రిప్ట్‌ని perl script.pl యూజర్‌నేమ్ పాస్‌వర్డ్‌ని ఉపయోగించి అమలు చేయవచ్చు.

ASAలో REST API డీబగ్గింగ్‌ని ప్రారంభిస్తోంది

ASAలో REST APIని కాన్ఫిగర్ చేయడంలో లేదా కనెక్ట్ చేయడంలో మీకు సమస్యలు ఉంటే, మీ కన్సోల్‌లో డీబగ్గింగ్ సందేశాల ప్రదర్శనను ప్రారంభించడానికి మీరు క్రింది CLI ఆదేశాన్ని ఉపయోగించవచ్చు. డీబగ్ సందేశాలను నిలిపివేయడానికి కమాండ్ యొక్క నో ఫారమ్‌ను ఉపయోగించండి.
డీబగ్ రెస్ట్-ఎపి [ఏజెంట్ | cli | క్లయింట్ | డెమన్ | ప్రక్రియ | టోకెన్-ప్రామాణీకరణ] [లోపం | ఈవెంట్] డీబగ్ రెస్ట్-ఎపిఐ లేదు

సింటాక్స్ వివరణ

• ఏజెంట్: (ఐచ్ఛికం) REST API ఏజెంట్ డీబగ్గింగ్ సమాచారాన్ని ప్రారంభించండి.
• cli: (ఐచ్ఛికం) REST API CLI డెమోన్-టు-ఏజెంట్ కమ్యూనికేషన్‌ల కోసం డీబగ్గింగ్ సందేశాలను ప్రారంభించండి.
• క్లయింట్: (ఐచ్ఛికం) REST API క్లయింట్ మరియు REST API ఏజెంట్ మధ్య సందేశ రూటింగ్ కోసం డీబగ్గింగ్ సమాచారాన్ని ప్రారంభించండి.
• డెమన్: (ఐచ్ఛికం) REST API డెమోన్-టు-ఏజెంట్ కమ్యూనికేషన్‌ల కోసం డీబగ్గింగ్ సందేశాలను ప్రారంభించండి.
• ప్రక్రియ: (ఐచ్ఛికం) REST API ఏజెంట్ ప్రాసెస్‌ను ప్రారంభించండి/డీబగ్గింగ్ సమాచారాన్ని ఆపివేయండి.
• టోకెన్-ప్రామాణీకరణ: (ఐచ్ఛికం) REST API టోకెన్ ప్రమాణీకరణ డీబగ్గింగ్ సమాచారం.
• లోపం: (ఐచ్ఛికం) డీబగ్ సందేశాలను API ద్వారా లాగ్ చేయబడిన ఎర్రర్‌లకు మాత్రమే పరిమితం చేయడానికి ఈ కీవర్డ్‌ని ఉపయోగించండి.
• సంఘటన: (ఐచ్ఛికం) డీబగ్ సందేశాలను API ద్వారా లాగిన్ చేసిన ఈవెంట్‌లకు మాత్రమే పరిమితం చేయడానికి ఈ కీవర్డ్‌ని ఉపయోగించండి.

వినియోగ మార్గదర్శకాలు

మీరు నిర్దిష్ట కాంపోనెంట్ కీవర్డ్‌ను అందించకపోతే (అంటే, మీరు డీబగ్ రెస్ట్-ఎపిఐ అనే కమాండ్‌ను జారీ చేస్తే), అన్ని కాంపోనెంట్ రకాల కోసం డీబగ్ సందేశాలు ప్రదర్శించబడతాయి. మీరు ఈవెంట్ లేదా ఎర్రర్ కీవర్డ్‌ని అందించకపోతే, పేర్కొన్న కాంపోనెంట్ కోసం ఈవెంట్ మరియు ఎర్రర్ మెసేజ్‌లు రెండూ ప్రదర్శించబడతాయి. ఉదాహరణకుample, డీబగ్ రెస్ట్-ఎపి డెమోన్ ఈవెంట్ API డెమన్-టు-ఏజెంట్ కమ్యూనికేషన్‌ల కోసం ఈవెంట్ డీబగ్ సందేశాలను మాత్రమే చూపుతుంది.

సంబంధిత ఆదేశాలు

కమాండ్ / వివరణ

• డీబగ్ HTTP; దీనికి ఈ ఆదేశాన్ని ఉపయోగించండి view HTTP ట్రాఫిక్ గురించి వివరణాత్మక సమాచారం.

ASA REST API-సంబంధిత Syslog సందేశాలు

ASA REST API-సంబంధిత సిస్టమ్-లాగ్ సందేశాలు ఈ విభాగంలో వివరించబడ్డాయి.

342001

• ఎర్రర్ మెసేజ్: %ASA-7-342001: REST API ఏజెంట్ విజయవంతంగా ప్రారంభించబడింది.
  • వివరణ: REST API క్లయింట్ ASAని కాన్ఫిగర్ చేయడానికి ముందు REST API ఏజెంట్ విజయవంతంగా ప్రారంభించబడాలి.
  • సిఫార్సు చేసిన చర్య: ఏదీ లేదు.

342002

• ఎర్రర్ మెసేజ్: %ASA-3-342002: REST API ఏజెంట్ విఫలమైంది, కారణం: కారణం
  • వివరణ: REST API ఏజెంట్ వివిధ కారణాల వల్ల ప్రారంభించడంలో విఫలం కావచ్చు లేదా క్రాష్ కావచ్చు మరియు కారణం పేర్కొనబడింది.
  • కారణం-REST API వైఫల్యానికి కారణం

సిఫార్సు చేసిన చర్య: లాగిన్ చేసిన కారణాన్ని బట్టి సమస్యను పరిష్కరించడానికి తీసుకున్న చర్యలు మారుతూ ఉంటాయి. ఉదాహరణకుample, జావా ప్రాసెస్ మెమరీ అయిపోయినప్పుడు REST API ఏజెంట్ క్రాష్ అవుతుంది. ఇలా జరిగితే, మీరు REST API ఏజెంట్‌ని పునఃప్రారంభించాలి. పునఃప్రారంభం విజయవంతం కాకపోతే, మూలకారణ పరిష్కారాన్ని గుర్తించడానికి Cisco 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 ASAvలో మద్దతు లేని ASA లక్షణాల జాబితా: http://www.cisco.com/c/en/us/td/docs/security/asa/asa92/configuration/general/asa-general-cli/introasav.html#pgfId-1156883

ఈ పత్రాన్ని "సంబంధిత డాక్యుమెంటేషన్" విభాగంలో అందుబాటులో ఉన్న పత్రాలతో కలిపి ఉపయోగించాలి.
Cisco మరియు Cisco లోగో అనేది US మరియు ఇతర దేశాలలో Cisco మరియు/లేదా దాని అనుబంధ సంస్థల యొక్క ట్రేడ్‌మార్క్‌లు లేదా నమోదిత ట్రేడ్‌మార్క్‌లు. కు view సిస్కో ట్రేడ్‌మార్క్‌ల జాబితా, దీనికి వెళ్లండి URL: www.cisco.com/go/trademarks. పేర్కొన్న థర్డ్-పార్టీ ట్రేడ్‌మార్క్‌లు వాటి సంబంధిత యజమానుల ఆస్తి. భాగస్వామి అనే పదాన్ని ఉపయోగించడం సిస్కో మరియు మరే ఇతర కంపెనీ మధ్య భాగస్వామ్య సంబంధాన్ని సూచించదు. (1721R)
ఈ డాక్యుమెంట్‌లో ఉపయోగించిన ఏదైనా ఇంటర్నెట్ ప్రోటోకాల్ (IP) చిరునామాలు మరియు ఫోన్ నంబర్‌లు అసలు చిరునామాలు మరియు ఫోన్ నంబర్‌లు కావు. ఏదైనా మాజీamples, కమాండ్ డిస్‌ప్లే అవుట్‌పుట్, నెట్‌వర్క్ టోపోలాజీ రేఖాచిత్రాలు మరియు డాక్యుమెంట్‌లో చేర్చబడిన ఇతర బొమ్మలు దృష్టాంత ప్రయోజనాల కోసం మాత్రమే చూపబడతాయి.
దృష్టాంత కంటెంట్‌లో అసలు IP చిరునామాలు లేదా ఫోన్ నంబర్‌ల యొక్క ఏదైనా ఉపయోగం అనుకోకుండా మరియు యాదృచ్ఛికం.

సిస్కో సిస్టమ్స్, ఇంక్.

• www.cisco.com

© 2014-2018 Cisco Systems, Inc. అన్ని హక్కులు ప్రత్యేకించబడ్డాయి.

పత్రాలు / వనరులు

CISCO ASA REST API యాప్ [pdf] యూజర్ గైడ్ ASA REST API యాప్, ASA, REST API యాప్, API యాప్, యాప్

సూచనలు

• వినియోగదారు మాన్యువల్