CISCO ASA REST API એપ્લિકેશન

સૂચનાઓનો ઉપયોગ કરીને ઉત્પાદન

ઉપરview

સિસ્કોના ASA REST API ના પ્રકાશન સાથે, તમારી પાસે હવે વ્યક્તિગત સિસ્કો ASA ને ગોઠવવા અને મેનેજ કરવા માટે અન્ય હળવા વજનનો, ઉપયોગમાં સરળ વિકલ્પ છે. ASA REST API એ RESTful સિદ્ધાંતો પર આધારિત એપ્લિકેશન પ્રોગ્રામિંગ ઇન્ટરફેસ (API) છે. તે કોઈપણ ASA પર ઝડપથી ડાઉનલોડ અને સક્ષમ કરી શકાય છે જ્યાં API ચાલી રહ્યું છે. સિસ્કો સિસ્ટમ્સ, Inc.

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 કૉલ્સ દ્વારા કરવામાં આવેલા ફેરફારો સ્ટાર્ટઅપ રૂપરેખાંકન પર ચાલુ રહેતા નથી પરંતુ તે ફક્ત ચાલી રહેલ રૂપરેખાંકનને સોંપવામાં આવે છે. સ્ટાર્ટઅપ રૂપરેખાંકનમાં ફેરફારોને સાચવવા માટે, તમે POST a write mem API વિનંતીનો ઉપયોગ કરી શકો છો. વધુ માહિતી માટે, ASA REST API વિષયવસ્તુના કોષ્ટક વિશે લખો મેમરી API એન્ટ્રીનો સંદર્ભ લો.

ASA REST API એજન્ટ અને ક્લાયન્ટને ઇન્સ્ટોલ અને ગોઠવો

નોંધ: REST API એજન્ટ એ Java-આધારિત એપ્લિકેશન છે. Java રનટાઇમ એન્વાયર્નમેન્ટ (JRE) REST API એજન્ટ પેકેજમાં બંડલ થયેલ છે.

ઉપરview

વ્યક્તિગત સિસ્કો ASA ને ગોઠવવા અને મેનેજ કરવા માટે કેટલાક વિકલ્પો ઉપલબ્ધ છે:

• કમાન્ડ લાઈન ઈન્ટરફેસ (CLI) - તમે કનેક્ટેડ કન્સોલ દ્વારા ASA ને સીધા જ નિયંત્રણ આદેશો મોકલો છો.
• એડેપ્ટિવ સિક્યોરિટી ડિવાઇસ મેનેજર (ASDM) – ગ્રાફિકલ યુઝર ઇન્ટરફેસ સાથેની "ઓન-બોક્સ" મેનેજમેન્ટ એપ્લિકેશન જેનો ઉપયોગ તમે ASAને ગોઠવવા, મેનેજ કરવા અને મોનિટર કરવા માટે કરી શકો છો.
• સિસ્કો સિક્યુરિટી મેનેજર - જ્યારે ઘણા સુરક્ષા ઉપકરણોના માધ્યમથી મોટા નેટવર્ક્સ માટે બનાવાયેલ છે, ત્યારે આ ગ્રાફિકલ એપ્લિકેશનનો ઉપયોગ વ્યક્તિગત ASA ને ગોઠવવા, મેનેજ કરવા અને મોનિટર કરવા માટે થઈ શકે છે.

સિસ્કોના ASA REST API ના પ્રકાશન સાથે, તમારી પાસે હવે બીજો હળવો, ઉપયોગમાં સરળ વિકલ્પ છે. આ એક એપ્લીકેશન પ્રોગ્રામિંગ ઈન્ટરફેસ (API) છે, જે “RESTful” સિદ્ધાંતો પર આધારિત છે, જેને તમે કોઈપણ ASA પર ઝડપથી ડાઉનલોડ અને સક્ષમ કરી શકો છો કે જેના પર API ચાલી રહ્યું છે.

તમારા બ્રાઉઝરમાં 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 રિસોર્સ નોટ ફાઉન્ડ ભૂલ પરત કરે છે.
• પોસ્ટ - પૂરી પાડવામાં આવેલ માહિતી સાથે ઑબ્જેક્ટ બનાવે છે.
• DELETE - ઉલ્લેખિત ઑબ્જેક્ટ કાઢી નાખે છે.
• પેચ - ઉલ્લેખિત ઑબ્જેક્ટ પર આંશિક ફેરફારો લાગુ કરે છે.

પ્રતિભાવ માળખું

• દરેક વિનંતી માનક હેડરો, પ્રતિભાવ સામગ્રી અને સ્થિતિ કોડ સાથે ASA તરફથી HTTPS પ્રતિસાદ ઉત્પન્ન કરે છે.

પ્રતિભાવ માળખું આ હોઈ શકે છે:

• સ્થાન - નવા બનાવેલ સંસાધન ID; માત્ર POST માટે-નવું સંસાધન ID ધરાવે છે (યુઆરઆઈ રજૂઆત તરીકે).
• સામગ્રી-પ્રકાર - પ્રતિભાવ સંદેશના મુખ્ય ભાગનું વર્ણન કરતો મીડિયા પ્રકાર; પ્રતિભાવ સંદેશના મુખ્ય ભાગની રજૂઆત અને વાક્યરચનાનું વર્ણન કરે છે.

દરેક પ્રતિભાવમાં HTTP સ્થિતિ અથવા ભૂલ કોડનો સમાવેશ થાય છે. ઉપલબ્ધ કોડ આ શ્રેણીઓમાં આવે છે:

• 20x - બે-સો શ્રેણીનો કોડ સફળ કામગીરી સૂચવે છે, જેમાં નીચેનાનો સમાવેશ થાય છે:
  • 200 ઓકે - સફળ વિનંતીઓ માટે માનક પ્રતિસાદ.
  • 201 બનાવ્યું - વિનંતી પૂર્ણ થઈ; નવા સંસાધન બનાવ્યા.
  • 202 સ્વીકાર્યું - વિનંતી સ્વીકારવામાં આવી, પરંતુ પ્રક્રિયા પૂર્ણ થઈ નથી.
  • 204 કોઈ સામગ્રી નથી - સર્વરે સફળતાપૂર્વક વિનંતી પર પ્રક્રિયા કરી; કોઈ સામગ્રી પરત કરવામાં આવી રહી નથી.
• 4xx - ચાર-સો શ્રેણીનો કોડ ક્લાયંટ-સાઇડ ભૂલ સૂચવે છે, જેમાં નીચેનાનો સમાવેશ થાય છે:
  • 400 ખરાબ વિનંતી - અમાન્ય ક્વેરી પરિમાણો, જેમાં અજાણ્યા પરિમાણો, ખૂટતા પરિમાણો અથવા અમાન્ય મૂલ્યોનો સમાવેશ થાય છે.
  • 404 મળ્યું નથી - પ્રદાન કરેલ છે URL હાલના સંસાધન સાથે મેળ ખાતું નથી. માજી માટેample, એક HTTP DELETE નિષ્ફળ થઈ શકે છે કારણ કે સંસાધન અનુપલબ્ધ છે.
  • 405 પદ્ધતિને મંજૂરી નથી - એક HTTP વિનંતી રજૂ કરવામાં આવી હતી જેને સંસાધન પર મંજૂરી નથી; માજી માટેample, ફક્ત વાંચવા માટેના સંસાધન પર પોસ્ટ કરો.
• 5xx - પાંચ-સો શ્રેણીનો કોડ સર્વર-સાઇડ ભૂલ સૂચવે છે.

ભૂલના કિસ્સામાં, એરર કોડ ઉપરાંત, રીટર્ન રિસ્પોન્સમાં ભૂલ વિશે વધુ વિગતો ધરાવતી એરર ઑબ્જેક્ટ શામેલ હોઈ શકે છે. JSON ભૂલ/ચેતવણી પ્રતિભાવ સ્કીમા નીચે મુજબ છે:

જ્યાં ઑબ્જેક્ટ ગુણધર્મો છે:

મિલકત	પ્રકાર	વર્ણન
સંદેશાઓ	શબ્દકોશોની સૂચિ	ભૂલ અથવા ચેતવણી સંદેશાઓની સૂચિ
કોડ	શબ્દમાળા	ભૂલ/ચેતવણી/માહિતી કોડ
વિગતો	શબ્દમાળા	ભૂલ/ચેતવણી/માહિતીને અનુરૂપ વિગતવાર સંદેશ

નોંધ: REST API કૉલ્સ દ્વારા કરવામાં આવેલ ASA રૂપરેખાંકનમાં ફેરફારો સ્ટાર્ટઅપ રૂપરેખાંકન પર ચાલુ રહેતા નથી; એટલે કે, ફેરફારો ફક્ત ચાલી રહેલ રૂપરેખાંકનને સોંપવામાં આવે છે. સ્ટાર્ટઅપ રૂપરેખાંકનમાં ફેરફારો સાચવવા માટે, તમે writemem API વિનંતી પોસ્ટ કરી શકો છો; વધુ માહિતી માટે, ASA REST API વિષયવસ્તુના કોષ્ટક વિશેની "Write Memory API" એન્ટ્રીને અનુસરો.

ASA REST API એજન્ટ અને ક્લાયન્ટને ઇન્સ્ટોલ અને ગોઠવો

• REST API એજન્ટ અન્ય ASA છબીઓ સાથે વ્યક્તિગત રીતે પ્રકાશિત થાય છે cisco.com. ભૌતિક ASAs માટે, 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. વિશિષ્ટ અનુકૂલનશીલ સુરક્ષા ઉપકરણો (ASA) મોડેલ શોધો અને પછી અનુકૂલનશીલ સુરક્ષા ઉપકરણ REST API પ્લગઇન પસંદ કરો.

નોંધ: REST API એજન્ટ એ Java-આધારિત એપ્લિકેશન છે. Java રનટાઇમ એન્વાયર્નમેન્ટ (JRE) REST API એજન્ટ પેકેજમાં બંડલ થયેલ છે.

ઉપયોગ માર્ગદર્શિકા

મહત્વપૂર્ણ તમારે બધા API કૉલ્સ અને હાલની સ્ક્રિપ્ટ્સમાં હેડર વપરાશકર્તા-એજન્ટ: REST API એજન્ટ શામેલ કરવું આવશ્યક છે. C માટે -H 'User-Agent: REST API એજન્ટ' નો ઉપયોગ કરોURL આદેશ બહુ-સંદર્ભ મોડમાં, REST API એજન્ટ આદેશો ફક્ત સિસ્ટમ સંદર્ભમાં જ ઉપલબ્ધ છે.

મહત્તમ સમર્થિત રૂપરેખાંકન કદ

ASA રેસ્ટ API એ ભૌતિક ASA ની અંદર ચાલતી "ઓન-બોર્ડ" એપ્લિકેશન છે, અને જેમ કે તેને ફાળવેલ મેમરી પર મર્યાદા છે. 2 અને 5555 જેવા તાજેતરના પ્લેટફોર્મ્સ પર પ્રકાશન ચક્રમાં મહત્તમ સમર્થિત ચાલી રહેલ રૂપરેખાંકન કદ લગભગ 5585 MB સુધી વધી ગયું છે. ASA Rest API પાસે વર્ચ્યુઅલ ASA પ્લેટફોર્મ્સ પર મેમરી અવરોધો પણ છે. ASAv5 પર કુલ મેમરી 1.5 GB હોઈ શકે છે, જ્યારે ASAv10 પર તે 2 GB છે. બાકીની API મર્યાદા ASAv450 અને ASAv500 માટે અનુક્રમે 5 KB અને 10 KB છે.

તેથી, ધ્યાન રાખો કે મોટી ચાલી રહેલ રૂપરેખાંકનો વિવિધ મેમરી-સઘન પરિસ્થિતિઓમાં અપવાદો પેદા કરી શકે છે જેમ કે મોટી સંખ્યામાં સહવર્તી વિનંતીઓ અથવા મોટી વિનંતી વોલ્યુમ. આ પરિસ્થિતિઓમાં, રેસ્ટ 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 image disk0:/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 નો ઉપયોગ કરીને, ખાતરી કરો કે HTTP સર્વર ASA પર સક્ષમ છે, અને 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 ક્લાયંટ ઇન્સ્ટોલ કરો. ફાયરફોક્સ માટે, RESTClient એડ-ઓન ઇન્સ્ટોલ કરો. ઇન્ટરનેટ એક્સપ્લોરર સપોર્ટેડ નથી.
• પગલું 2: તમારા બ્રાઉઝરનો ઉપયોગ કરીને નીચેની વિનંતી શરૂ કરો: https: /api/objects/networkobjects
  • જો તમને ભૂલ વિનાનો પ્રતિસાદ મળે, તો તમે ASA પર કાર્યરત REST API એજન્ટ સુધી પહોંચી ગયા છો.
  • જો તમને એજન્ટ વિનંતિમાં સમસ્યા આવી રહી હોય, તો તમે CLI કન્સોલ પર ડિબગીંગ માહિતીના પ્રદર્શનને સક્ષમ કરી શકો છો, જેમ કે ASA પર REST API ડિબગીંગ સક્ષમ કરવામાં વર્ણવેલ છે.
• પગલું 3: વૈકલ્પિક રીતે, તમે POST ઓપરેશન કરીને ASA સાથે તમારા કનેક્શનનું પરીક્ષણ કરી શકો છો.

માજી માટેampલે: મૂળભૂત અધિકૃતતા પ્રમાણપત્રો પ્રદાન કરો ( ), અથવા પ્રમાણીકરણ ટોકન (વધારાની માહિતી માટે ટોકન પ્રમાણીકરણ જુઓ).

• લક્ષ્ય વિનંતી સરનામું: https://<asa management ipaddress>/api/objects/networkobjects
• શારીરિક સામગ્રી પ્રકાર: એપ્લિકેશન/જેસન

ઓપરેશનનું કાચું શરીર:

તમે હવે ASA ને ગોઠવવા અને મોનિટર કરવા માટે ASA REST API નો ઉપયોગ કરી શકો છો. કૉલ વર્ણનો અને ભૂતપૂર્વ માટે API દસ્તાવેજોનો સંદર્ભ લોampલેસ

બેક-અપ રૂપરેખાંકનને સંપૂર્ણપણે પુનઃસ્થાપિત કરવા વિશે

REST API નો ઉપયોગ કરીને ASA પર સંપૂર્ણ બેક-અપ ગોઠવણી પુનઃસ્થાપિત કરવાથી ASA ફરીથી લોડ થશે. આને અવગણવા માટે, બેક-અપ રૂપરેખાંકન પુનઃસ્થાપિત કરવા માટે નીચેના આદેશનો ઉપયોગ કરો:

• {
  • "આદેશો":["copy /noconfirm disk0:/fileનામ> રનિંગ-રૂપરેખા"]
• }
  • જ્યાંfilename> backup.cfg છે અથવા રૂપરેખાંકનનો બેકઅપ લેતી વખતે તમે જે પણ નામનો ઉપયોગ કર્યો છે.

દસ્તાવેજીકરણ કન્સોલ અને નિકાસ API સ્ક્રિપ્ટ

તમે ASA પર સીધા API કૉલ્સ વિશે શીખવા અને અજમાવવા માટે "સેન્ડબોક્સ" તરીકે host:port/doc/ પર ઉપલબ્ધ REST API ઓન-લાઇન દસ્તાવેજીકરણ કન્સોલ (જેને "Doc UI" તરીકે ઓળખવામાં આવે છે) નો પણ ઉપયોગ કરી શકો છો. આગળ, તમે પ્રદર્શિત પદ્ધતિને સાચવવા માટે દસ્તાવેજ UI માં એક્સપોર્ટ ઓપરેશન બટનનો ઉપયોગ કરી શકો છોample JavaScript, Python, અથવા Perl સ્ક્રિપ્ટ તરીકે file તમારા સ્થાનિક યજમાનને. પછી તમે આ સ્ક્રિપ્ટને તમારા ASA પર લાગુ કરી શકો છો, અને અન્ય ASA અને અન્ય નેટવર્ક ઉપકરણો પર એપ્લિકેશન માટે તેને સંપાદિત કરી શકો છો. આનો અર્થ મુખ્યત્વે શૈક્ષણિક અને બુટસ્ટ્રેપિંગ સાધન તરીકે હતો.

જાવાસ્ક્રિપ્ટ

• JavaScript નો ઉપયોગ કરવો file node.js ના ઇન્સ્ટોલેશનની જરૂર છે, જે અહીં મળી શકે છે http://nodejs.org/.
• node.js નો ઉપયોગ કરીને, તમે JavaScript ચલાવી શકો છો file, સામાન્ય રીતે બ્રાઉઝર માટે લખવામાં આવે છે, જેમ કે કમાન્ડ-લાઇન સ્ક્રિપ્ટ. ફક્ત ઇન્સ્ટોલેશન સૂચનાઓને અનુસરો, અને પછી તમારી સ્ક્રિપ્ટને નોડ script.js સાથે ચલાવો.

અજગર

• Python સ્ક્રિપ્ટો માટે તમારે Python ઇન્સ્ટોલ કરવાની જરૂર છે, જેમાંથી ઉપલબ્ધ છે https://www.python.org/.
• એકવાર તમે Python ઇન્સ્ટોલ કરી લો, પછી તમે તમારી સ્ક્રિપ્ટને 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મેકિન્ટોશ પર પર્લને બુટસ્ટ્રેપિંગ કરવાની રીત:

• $ sudo perl -MCPAN e શેલ
• cpan> બંડલ ઇન્સ્ટોલ કરો::CPAN
• cpan> REST ઇન્સ્ટોલ કરો:: ક્લાયન્ટ
• cpan> MIME ઇન્સ્ટોલ કરો::બેઝ64
• cpan> JSON ઇન્સ્ટોલ કરો

નિર્ભરતાઓ ઇન્સ્ટોલ કર્યા પછી, તમે perl script.pl વપરાશકર્તાનામ પાસવર્ડનો ઉપયોગ કરીને તમારી સ્ક્રિપ્ટ ચલાવી શકો છો.

ASA પર REST API ડિબગીંગને સક્ષમ કરી રહ્યું છે

જો તમને ASA પર REST API ને રૂપરેખાંકિત કરવામાં અથવા કનેક્ટ કરવામાં સમસ્યા આવી રહી છે, તો તમે તમારા કન્સોલ પર ડિબગીંગ સંદેશાઓના પ્રદર્શનને સક્ષમ કરવા માટે નીચેના CLI આદેશનો ઉપયોગ કરી શકો છો. ડિબગ સંદેશાઓને નિષ્ક્રિય કરવા માટે આદેશના નો ફોર્મનો ઉપયોગ કરો.
debug rest-api [એજન્ટ | cli | ગ્રાહક | ડિમન | પ્રક્રિયા | token-auth] [ભૂલ | ઇવેન્ટ] કોઈ ડીબગ રેસ્ટ-એપીઆઈ નથી

વાક્યરચના વર્ણન

• એજન્ટ: (વૈકલ્પિક) REST API એજન્ટ ડીબગીંગ માહિતી સક્ષમ કરો.
• cli: (વૈકલ્પિક) REST API CLI ડેમન-ટુ-એજન્ટ સંચાર માટે ડિબગીંગ સંદેશાઓને સક્ષમ કરો.
• ગ્રાહક: (વૈકલ્પિક) REST API ક્લાયંટ અને REST API એજન્ટ વચ્ચે મેસેજ રૂટીંગ માટે ડીબગીંગ માહિતી સક્ષમ કરો.
• ડિમન (વૈકલ્પિક) REST API ડિમન-ટુ-એજન્ટ સંચાર માટે ડિબગીંગ સંદેશાઓને સક્ષમ કરો.
• પ્રક્રિયા: (વૈકલ્પિક) REST API એજન્ટ પ્રક્રિયા શરૂ/બંધ ડિબગીંગ માહિતી સક્ષમ કરો.
• ટોકન-ઓથ: (વૈકલ્પિક) REST API ટોકન પ્રમાણીકરણ ડીબગીંગ માહિતી.
• ભૂલ (વૈકલ્પિક) આ કીવર્ડનો ઉપયોગ ડીબગ સંદેશાઓને ફક્ત API દ્વારા લોગ કરાયેલી ભૂલો સુધી મર્યાદિત કરવા માટે કરો.
• ઘટના: (વૈકલ્પિક) ડીબગ સંદેશાઓને ફક્ત API દ્વારા લોગ કરાયેલી ઇવેન્ટ્સ સુધી મર્યાદિત કરવા માટે આ કીવર્ડનો ઉપયોગ કરો.

ઉપયોગ માર્ગદર્શિકા

જો તમે ચોક્કસ ઘટક કીવર્ડ (એટલે ​​​​કે, જો તમે ફક્ત ડીબગ રેસ્ટ-એપીઆઈ આદેશ જારી કરો છો), તો ડીબગ સંદેશાઓ તમામ ઘટક પ્રકારો માટે પ્રદર્શિત થાય છે. જો તમે ઇવેન્ટ અથવા એરર કીવર્ડ આપતા નથી, તો ઉલ્લેખિત ઘટક માટે ઇવેન્ટ અને ભૂલ સંદેશાઓ બંને પ્રદર્શિત થાય છે. માજી માટેample, ડીબગ રેસ્ટ-એપીઆઈ ડિમન ઇવેન્ટ એપીઆઈ ડિમન-ટુ-એજન્ટ સંચાર માટે માત્ર ઇવેન્ટ ડીબગ સંદેશાઓ બતાવશે.

સંબંધિત આદેશો

આદેશ/વર્ણન

• ડીબગ 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 નિષ્ફળતા માટેનું કારણ

ભલામણ કરેલ ક્રિયા: લૉગ કરેલા કારણના આધારે સમસ્યાને ઉકેલવા માટે લેવામાં આવતી ક્રિયાઓ બદલાય છે. માજી માટેampલે, REST API એજન્ટ જ્યારે જાવા પ્રક્રિયાની મેમરી સમાપ્ત થઈ જાય ત્યારે ક્રેશ થાય છે. જો આવું થાય, તો તમારે REST API એજન્ટને ફરી શરૂ કરવાની જરૂર છે. જો પુનઃપ્રારંભ સફળ ન થાય, તો મૂળ કારણ સુધારવા માટે Cisco TAC નો સંપર્ક કરો.

342003

• ભૂલ સંદેશ: %ASA-3-342003: REST API એજન્ટ નિષ્ફળતાની સૂચના પ્રાપ્ત થઈ. એજન્ટ આપમેળે ફરી શરૂ થશે.
  • સમજૂતી: REST API એજન્ટ તરફથી નિષ્ફળતાની સૂચના પ્રાપ્ત થઈ છે અને એજન્ટને ફરી શરૂ કરવાનો પ્રયાસ કરવામાં આવી રહ્યો છે.
  • ભલામણ કરેલ ક્રિયા: કોઈ નહિ.

342004

• ભૂલ સંદેશ: %ASA-3-342004: 5 અસફળ પ્રયાસો પછી REST API એજન્ટને આપમેળે પુનઃપ્રારંભ કરવામાં નિષ્ફળ. એજન્ટને મેન્યુઅલી રીસ્ટાર્ટ કરવા માટે 'no rest-api agent' અને 'rest-api agent' આદેશોનો ઉપયોગ કરો.
  • સમજૂતી: REST API એજન્ટ ઘણા પ્રયત્નો પછી શરૂ કરવામાં નિષ્ફળ ગયો છે.
  • ભલામણ કરેલ ક્રિયા: નિષ્ફળતા પાછળનું કારણ વધુ સારી રીતે સમજવા માટે syslog %ASA-3-342002 (જો લોગ થયેલ હોય તો) જુઓ. નો રેસ્ટ-એપીઆઈ એજન્ટ આદેશ દાખલ કરીને REST API એજન્ટને અક્ષમ કરવાનો પ્રયાસ કરો અને rest-api એજન્ટ આદેશનો ઉપયોગ કરીને REST API એજન્ટને ફરીથી સક્ષમ કરો.

સંબંધિત દસ્તાવેજીકરણ

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 લોગો એ US અને અન્ય દેશોમાં Cisco અને/અથવા તેના આનુષંગિકોના ટ્રેડમાર્ક અથવા રજિસ્ટર્ડ ટ્રેડમાર્ક છે. થી view સિસ્કો ટ્રેડમાર્ક્સની સૂચિ, આ પર જાઓ URL: www.cisco.com/go/trademark. ઉલ્લેખિત તૃતીય-પક્ષ ટ્રેડમાર્ક્સ તેમના સંબંધિત માલિકોની મિલકત છે. ભાગીદાર શબ્દનો ઉપયોગ સિસ્કો અને અન્ય કોઈપણ કંપની વચ્ચે ભાગીદારી સંબંધને સૂચિત કરતું નથી. (1721R)
આ દસ્તાવેજમાં વપરાતા કોઈપણ ઈન્ટરનેટ પ્રોટોકોલ (IP) સરનામાંઓ અને ફોન નંબરો વાસ્તવિક સરનામાં અને ફોન નંબરો હોવાનો હેતુ નથી. કોઈપણ ભૂતપૂર્વampલેસ, કમાન્ડ ડિસ્પ્લે આઉટપુટ, નેટવર્ક ટોપોલોજી ડાયાગ્રામ અને દસ્તાવેજમાં સમાવિષ્ટ અન્ય આકૃતિઓ માત્ર દૃષ્ટાંતરૂપ હેતુઓ માટે બતાવવામાં આવે છે.
ચિત્રાત્મક સામગ્રીમાં વાસ્તવિક IP સરનામાં અથવા ફોન નંબરનો કોઈપણ ઉપયોગ અજાણતા અને સંયોગાત્મક છે.

સિસ્કો સિસ્ટમ્સ, Inc.

• www.cisco.com

© 2014-2018 Cisco Systems, Inc. સર્વાધિકાર સુરક્ષિત.

દસ્તાવેજો / સંસાધનો

CISCO ASA REST API એપ્લિકેશન [પીડીએફ] વપરાશકર્તા માર્ગદર્શિકા ASA REST API એપ્લિકેશન, ASA, REST API એપ્લિકેશન, API એપ્લિકેશન, એપ્લિકેશન

સંદર્ભો

• વપરાશકર્તા માર્ગદર્શિકા