និមិត្តសញ្ញា CISCO

កម្មវិធី CISCO ASA REST API

CISCO-ASA-REST-API-App-product

ការណែនាំអំពីការប្រើប្រាស់ផលិតផល

ជាងview

ជាមួយនឹងការចេញផ្សាយ ASA REST API របស់ Cisco ឥឡូវនេះ អ្នកមានជម្រើសដ៏ស្រាល និងងាយស្រួលប្រើមួយផ្សេងទៀតសម្រាប់ការកំណត់ និងគ្រប់គ្រង Cisco ASAs នីមួយៗ។ ASA REST API គឺជាចំណុចប្រទាក់កម្មវិធីកម្មវិធី (API) ដោយផ្អែកលើគោលការណ៍ RESTful ។ វាអាចត្រូវបានទាញយក និងបើកដំណើរការយ៉ាងរហ័សនៅលើ ASA ណាមួយដែល API កំពុងដំណើរការ។ Cisco Systems, Inc.

www.cisco.com

ASA REST API សំណើ និងការឆ្លើយតប

បន្ទាប់ពីដំឡើងកម្មវិធីភ្ញៀវ REST នៅក្នុងកម្មវិធីរុករករបស់អ្នក អ្នកអាចទាក់ទងភ្នាក់ងារ REST របស់ ASA ជាក់លាក់ និងប្រើវិធីសាស្ត្រ HTTP ស្តង់ដារ ដើម្បីចូលប្រើព័ត៌មានការកំណត់រចនាសម្ព័ន្ធបច្ចុប្បន្ន និងចេញប៉ារ៉ាម៉ែត្រកំណត់រចនាសម្ព័ន្ធបន្ថែម។

ប្រយ័ត្ន៖ នៅពេលដែល REST API ត្រូវបានបើកនៅលើ ASA ការតភ្ជាប់ដោយពិធីការគ្រប់គ្រងសុវត្ថិភាពផ្សេងទៀតមិនត្រូវបានរារាំងទេ។ នេះមានន័យថាអ្នកផ្សេងទៀតដែលប្រើ CLI, ASDM, ឬ Security Manager អាចនឹងផ្លាស់ប្តូរការកំណត់ ASA ខណៈពេលដែលអ្នកកំពុងធ្វើដូចគ្នា។

ស្នើសុំរចនាសម្ព័ន្ធ

ASA REST API ផ្តល់ឱ្យអ្នកនូវការចូលដំណើរការតាមកម្មវិធីដើម្បីគ្រប់គ្រង ASAs បុគ្គលតាមរយៈ Representational State Transfer (REST)API។ API អនុញ្ញាតឱ្យអតិថិជនខាងក្រៅធ្វើប្រតិបត្តិការ CRUD (បង្កើត អាន ធ្វើបច្ចុប្បន្នភាព លុប) លើធនធាន ASA ។ សំណើ API ទាំងអស់ត្រូវបានផ្ញើតាម HTTPS ទៅ ASA ហើយការឆ្លើយតបនឹងត្រលប់មកវិញ។

កន្លែងដែលវត្ថុមានលក្ខណៈសម្បត្តិ៖

ទ្រព្យសម្បត្តិ ប្រភេទ ការពិពណ៌នា
សារ បញ្ជីវចនានុក្រម បញ្ជីនៃកំហុស ឬសារព្រមាន
កូដ ខ្សែអក្សរ សារលម្អិតដែលត្រូវគ្នានឹងកំហុស/ការព្រមាន/ព័ត៌មាន
ព័ត៌មានលម្អិត ខ្សែអក្សរ សារលម្អិតដែលត្រូវគ្នានឹងកំហុស/ការព្រមាន/ព័ត៌មាន

ចំណាំ៖ ការផ្លាស់ប្តូរដែលបានធ្វើឡើងដោយការហៅទូរសព្ទ REST API មិនត្រូវបានបន្តចំពោះការកំណត់រចនាសម្ព័ន្ធចាប់ផ្តើមទេ ប៉ុន្តែត្រូវបានចាត់តាំងតែចំពោះការកំណត់ដែលកំពុងដំណើរការប៉ុណ្ណោះ។ ដើម្បីរក្សាទុកការផ្លាស់ប្តូរចំពោះការកំណត់រចនាសម្ព័ន្ធចាប់ផ្តើម អ្នកអាចប្រើ POST a write mem API ស្នើសុំ។ សម្រាប់ព័ត៌មានបន្ថែម សូមមើលធាតុ Write Memory API នៅក្នុងតារាងមាតិកាអំពី ASA REST API ។

ដំឡើង និងកំណត់រចនាសម្ព័ន្ធ ASA REST API ភ្នាក់ងារ និងអតិថិជន

ចំណាំ៖ ភ្នាក់ងារ REST API គឺជាកម្មវិធីដែលមានមូលដ្ឋានលើ Java ។ Java Runtime Environment (JRE) ត្រូវបានបញ្ចូលក្នុងកញ្ចប់ REST API Agent ។

ជាងview

ជម្រើសជាច្រើនមានសម្រាប់កំណត់រចនាសម្ព័ន្ធ និងគ្រប់គ្រង Cisco ASAs នីមួយៗ៖

  • ចំណុចប្រទាក់បន្ទាត់ពាក្យបញ្ជា (CLI) - អ្នកផ្ញើពាក្យបញ្ជាដោយផ្ទាល់ទៅ ASA តាមរយៈកុងសូលដែលបានតភ្ជាប់។
  • Adaptive Security Device Manager (ASDM) - កម្មវិធីគ្រប់គ្រង "on-box" ដែលមានចំណុចប្រទាក់អ្នកប្រើក្រាហ្វិកដែលអ្នកអាចប្រើដើម្បីកំណត់រចនាសម្ព័ន្ធ គ្រប់គ្រង និងត្រួតពិនិត្យ ASA ។
  • កម្មវិធីគ្រប់គ្រងសុវត្ថិភាព Cisco – ខណៈដែលមានបំណងសម្រាប់បណ្តាញមធ្យមទៅធំនៃឧបករណ៍សុវត្ថិភាពជាច្រើន កម្មវិធីក្រាហ្វិកនេះអាចត្រូវបានប្រើដើម្បីកំណត់រចនាសម្ព័ន្ធ គ្រប់គ្រង និងត្រួតពិនិត្យ ASAs នីមួយៗ។

ជាមួយនឹងការចេញផ្សាយ ASA REST API របស់ Cisco ឥឡូវនេះ អ្នកមានជម្រើសស្រាល និងងាយស្រួលប្រើមួយផ្សេងទៀត។ នេះគឺជាចំណុចប្រទាក់កម្មវិធីកម្មវិធី (API) ដោយផ្អែកលើគោលការណ៍ "RESTful" ដែលអ្នកអាចទាញយក និងបើកដំណើរការបានយ៉ាងឆាប់រហ័សនៅលើ ASA ដែល API កំពុងដំណើរការ។

បន្ទាប់ពីដំឡើងកម្មវិធីភ្ញៀវ REST នៅក្នុងកម្មវិធីរុករករបស់អ្នក អ្នកអាចទាក់ទងភ្នាក់ងារ REST របស់ ASA ជាក់លាក់ និងប្រើវិធីសាស្ត្រ HTTP ស្តង់ដារដើម្បីចូលប្រើព័ត៌មានការកំណត់រចនាសម្ព័ន្ធបច្ចុប្បន្ន និងចេញប៉ារ៉ាម៉ែត្រកំណត់រចនាសម្ព័ន្ធបន្ថែម។

ប្រយ័ត្ន៖ នៅពេលដែល REST API ត្រូវបានបើកនៅលើ ASA ការតភ្ជាប់ដោយពិធីការគ្រប់គ្រងសុវត្ថិភាពផ្សេងទៀតមិនត្រូវបានរារាំងទេ។ នេះមានន័យថាអ្នកផ្សេងទៀតដែលប្រើ CLI, ASDM, ឬ Security Manager អាចនឹងផ្លាស់ប្តូរការកំណត់ ASA ខណៈពេលដែលអ្នកកំពុងធ្វើដូចគ្នា។

ASA REST API សំណើ និងការឆ្លើយតប

ASA REST API ផ្តល់ឱ្យអ្នកនូវការចូលដំណើរការតាមកម្មវិធីដើម្បីគ្រប់គ្រង ASAs បុគ្គលតាមរយៈ Representational State Transfer (REST) ​​API។ API អនុញ្ញាតឱ្យអតិថិជនខាងក្រៅធ្វើប្រតិបត្តិការ CRUD (បង្កើត អាន ធ្វើបច្ចុប្បន្នភាព លុប) លើធនធាន ASA ។ វាត្រូវបានផ្អែកលើពិធីការ HTTPS និងវិធីសាស្ត្រ REST ។ សំណើ API ទាំងអស់ត្រូវបានផ្ញើតាម HTTPS ទៅ ASA ហើយការឆ្លើយតបនឹងត្រលប់មកវិញ។ ផ្នែកនេះផ្តល់នូវការបញ្ចប់view អំពីរបៀបដែលសំណើត្រូវបានរៀបចំឡើង និងការឆ្លើយតបដែលរំពឹងទុក

ស្នើសុំរចនាសម្ព័ន្ធ

វិធីសាស្រ្តស្នើសុំដែលមានគឺ៖

  • GET - ទាញយកទិន្នន័យពីវត្ថុដែលបានបញ្ជាក់។
  • PUT - បន្ថែមព័ត៌មានដែលបានផ្តល់ឱ្យទៅវត្ថុដែលបានបញ្ជាក់; ត្រឡប់កំហុស 404 Resource Not Found ប្រសិនបើវត្ថុមិនមាន។
  • POST - បង្កើតវត្ថុជាមួយនឹងព័ត៌មានដែលបានផ្តល់។
  • DELETE - លុបវត្ថុដែលបានបញ្ជាក់។
  • PATCH - អនុវត្តការកែប្រែមួយផ្នែកទៅវត្ថុដែលបានបញ្ជាក់។

រចនាសម្ព័ន្ធឆ្លើយតប

  • សំណើនីមួយៗបង្កើតការឆ្លើយតប HTTPS ពី ASA ជាមួយនឹងបឋមកថាស្តង់ដារ មាតិកាឆ្លើយតប និងលេខកូដស្ថានភាព។

រចនាសម្ព័ន្ធឆ្លើយតបអាចជា៖

  • ទីតាំង - លេខសម្គាល់ធនធានដែលបានបង្កើតថ្មី; សម្រាប់ POST តែប៉ុណ្ណោះ—កាន់លេខសម្គាល់ធនធានថ្មី (ជាតំណាង URI)។
  • ប្រភេទមាតិកា - ប្រភេទប្រព័ន្ធផ្សព្វផ្សាយដែលពិពណ៌នាអំពីតួសារឆ្លើយតប។ ពិពណ៌នាអំពីតំណាង និងវាក្យសម្ព័ន្ធនៃតួសារឆ្លើយតប។

ការឆ្លើយតបនីមួយៗរួមមានស្ថានភាព HTTP ឬលេខកូដកំហុស។ លេខកូដដែលមាននៅក្នុងប្រភេទទាំងនេះ៖

  • 20x - លេខកូដស៊េរីចំនួនពីររយបង្ហាញពីប្រតិបត្តិការជោគជ័យ រួមទាំង៖
    • 200 យល់ព្រម – ការឆ្លើយតបស្តង់ដារសម្រាប់សំណើជោគជ័យ។
    • 201 បានបង្កើត - សំណើបានបញ្ចប់; ធនធានថ្មីត្រូវបានបង្កើតឡើង។
    • 202 បានទទួលយក – សំណើត្រូវបានទទួលយក ប៉ុន្តែដំណើរការមិនបានបញ្ចប់ទេ។
    • 204 គ្មានខ្លឹមសារ – ម៉ាស៊ីនមេបានដំណើរការសំណើដោយជោគជ័យ។ គ្មានខ្លឹមសារត្រូវបានបញ្ជូនមកវិញទេ។
  • 4xx - លេខកូដស៊េរីបួនរយបង្ហាញពីកំហុសខាងអតិថិជន រួមទាំង៖
    • 400 សំណើមិនល្អ - ប៉ារ៉ាម៉ែត្រសំណួរមិនត្រឹមត្រូវ រួមទាំងប៉ារ៉ាម៉ែត្រដែលមិនទទួលស្គាល់ ប៉ារ៉ាម៉ែត្រដែលបាត់ ឬតម្លៃមិនត្រឹមត្រូវ។
    • 404 រកមិនឃើញ - ផ្តល់ជូន URL មិនត្រូវគ្នានឹងធនធានដែលមានស្រាប់ទេ។ សម្រាប់អតីតampដូច្នេះ HTTP DELETE អាចនឹងបរាជ័យ ដោយសារធនធានមិនអាចប្រើបាន។
    • 405 វិធីសាស្រ្តមិនត្រូវបានអនុញ្ញាត - សំណើ HTTP ត្រូវបានបង្ហាញដែលមិនត្រូវបានអនុញ្ញាតនៅលើធនធាន។ សម្រាប់អតីតample ជា POST នៅលើធនធានដែលបានតែអាន។
  • 5xx - លេខកូដស៊េរីប្រាំរយបង្ហាញពីកំហុសផ្នែកខាងម៉ាស៊ីនមេ។

ក្នុងករណីមានកំហុស បន្ថែមពីលើលេខកូដកំហុស ការឆ្លើយតបអាចរួមបញ្ចូលវត្ថុកំហុសដែលមានព័ត៌មានលម្អិតបន្ថែមអំពីកំហុស។ គ្រោងការណ៍ការឆ្លើយតបកំហុស/ការព្រមានរបស់ JSON មានដូចខាងក្រោម៖

CISCO-ASA-REST-API-App-fig-1

កន្លែងដែលវត្ថុមានលក្ខណៈសម្បត្តិ៖

ទ្រព្យសម្បត្តិ ប្រភេទ ការពិពណ៌នា
សារ បញ្ជីវចនានុក្រម បញ្ជីនៃកំហុស ឬសារព្រមាន
កូដ ខ្សែអក្សរ កំហុស/ការព្រមាន/លេខកូដព័ត៌មាន
ព័ត៌មានលម្អិត ខ្សែអក្សរ សារលម្អិតដែលត្រូវគ្នានឹងកំហុស/ការព្រមាន/ព័ត៌មាន

ចំណាំ៖ ការផ្លាស់ប្តូរការកំណត់រចនាសម្ព័ន្ធ ASA ដែលធ្វើឡើងដោយការហៅ REST API មិនត្រូវបានបន្តចំពោះការកំណត់រចនាសម្ព័ន្ធចាប់ផ្តើមទេ។ នោះគឺការផ្លាស់ប្តូរត្រូវបានកំណត់តែចំពោះការកំណត់រចនាសម្ព័ន្ធដែលកំពុងដំណើរការប៉ុណ្ណោះ។ ដើម្បីរក្សាទុកការផ្លាស់ប្តូរចំពោះការកំណត់រចនាសម្ព័ន្ធចាប់ផ្តើម អ្នកអាចបង្ហោះសំណើ API របស់ writemem ។ សម្រាប់ព័ត៌មានបន្ថែម សូមអនុវត្តតាមធាតុ "សរសេរ Memory API" នៅក្នុងតារាងមាតិកាអំពី ASA REST API ។

ដំឡើង និងកំណត់រចនាសម្ព័ន្ធ ASA REST API ភ្នាក់ងារ និងអតិថិជន

  • ភ្នាក់ងារ REST API ត្រូវបានបោះពុម្ពជាលក្ខណៈបុគ្គលជាមួយនឹងរូបភាព ASA ផ្សេងទៀតនៅលើ cisco.com. សម្រាប់ ASAs ជាក់ស្តែង កញ្ចប់ REST API ត្រូវតែទាញយកទៅ flash របស់ឧបករណ៍ ហើយដំឡើងដោយប្រើពាក្យបញ្ជា "rest-api image" ។ បន្ទាប់មកភ្នាក់ងារ REST API ត្រូវបានបើកដោយប្រើពាក្យបញ្ជា "ភ្នាក់ងារ rest-api" ។
  • ជាមួយនឹង ASA និម្មិត (ASAv) រូបភាព REST API ត្រូវតែទាញយកទៅភាគថាស "boot:" ។ បន្ទាប់មក អ្នកត្រូវតែចេញពាក្យបញ្ជា “rest-api image” បន្តដោយពាក្យបញ្ជា “rest-api agent” ដើម្បីចូលប្រើ និងបើកដំណើរការ REST API Agent។
  • សម្រាប់ព័ត៌មានអំពីកម្មវិធី REST API និងតម្រូវការផ្នែករឹង និងភាពឆបគ្នា សូមមើលម៉ាទ្រីស Cisco ASA Compatibility។
  • អ្នកអាចទាញយកកញ្ចប់ REST API សមរម្យសម្រាប់ ASA ឬ ASAv របស់អ្នកពី software.cisco.com/download/home. កំណត់ទីតាំងជាក់លាក់នៃម៉ូដែល Adaptive Security Appliances (ASA) ហើយបន្ទាប់មកជ្រើសរើស Adaptive Security Appliance REST API Plugin ។

ចំណាំ៖ ភ្នាក់ងារ REST API គឺជាកម្មវិធីដែលមានមូលដ្ឋានលើ Java ។ Java Runtime Environment (JRE) ត្រូវបានបញ្ចូលក្នុងកញ្ចប់ REST API Agent ។

ការណែនាំអំពីការប្រើប្រាស់

សំខាន់អ្នកត្រូវតែបញ្ចូលបឋមកថា User-Agent: REST API Agent នៅក្នុងការហៅ API ទាំងអស់ និងស្គ្រីបដែលមានស្រាប់។ ប្រើ -H 'User-Agent: REST API Agent' សម្រាប់ CURL បញ្ជា។ នៅក្នុងរបៀបពហុបរិបទ ពាក្យបញ្ជា REST API Agent មាននៅក្នុងបរិបទប្រព័ន្ធប៉ុណ្ណោះ។

ទំហំកំណត់រចនាសម្ព័ន្ធដែលគាំទ្រអតិបរមា

ASA Rest API គឺជាកម្មវិធី "នៅលើយន្តហោះ" ដែលដំណើរការនៅខាងក្នុង ASA រាងកាយ ហើយដូច្នេះមានដែនកំណត់លើអង្គចងចាំដែលបានបម្រុងទុកសម្រាប់វា។ ទំហំកំណត់រចនាសម្ព័ន្ធដែលកំពុងដំណើរការដែលគាំទ្រអតិបរមាបានកើនឡើងជុំវិញវដ្តនៃការចេញផ្សាយដល់ប្រហែល 2 MB នៅលើវេទិកាថ្មីៗដូចជា 5555 និង 5585។ ASA Rest API ក៏មានកំហិតអង្គចងចាំនៅលើវេទិកា ASA និម្មិតផងដែរ។ អង្គចងចាំសរុបនៅលើ ASAv5 អាចមាន 1.5 GB ខណៈពេលដែលនៅលើ ASAv10 វាមាន 2 GB ។ ដែនកំណត់ Rest API គឺ 450 KB និង 500 KB សម្រាប់ ASAv5 និង ASAv10 រៀងគ្នា។

ដូច្នេះត្រូវដឹងថាការកំណត់រចនាសម្ព័ន្ធដែលកំពុងដំណើរការធំអាចបង្កើតករណីលើកលែងក្នុងស្ថានភាពដែលពឹងផ្អែកលើអង្គចងចាំផ្សេងៗ ដូចជាសំណើមួយចំនួនធំដំណាលគ្នា ឬបរិមាណសំណើធំ។ ក្នុងស្ថានភាពទាំងនេះ Rest API GET/PUT/POST calls អាចចាប់ផ្តើមបរាជ័យជាមួយនឹង 500 – Internal Server Error messages ហើយ Rest API Agent នឹងចាប់ផ្តើមឡើងវិញដោយស្វ័យប្រវត្តិរាល់ពេល។ ដំណោះស្រាយចំពោះស្ថានភាពនេះគឺអាចផ្លាស់ទីទៅវេទិកា ASA/FPR ឬ ASAV ដែលមានអង្គចងចាំខ្ពស់ ឬកាត់បន្ថយទំហំនៃការកំណត់ដែលកំពុងដំណើរការ។

ទាញយក និងដំឡើងភ្នាក់ងារ REST API

ដោយប្រើ CLI សូមអនុវត្តតាមជំហានទាំងនេះដើម្បីទាញយក និងដំឡើងភ្នាក់ងារ ASA REST API នៅលើ ASA ជាក់លាក់មួយ៖

  • ជំហានទី 1៖ នៅលើ ASA ដែលចង់បាន សូមចេញច្បាប់ចម្លង disk0: ពាក្យបញ្ជាដើម្បីទាញយកកញ្ចប់ ASA REST API បច្ចុប្បន្នពី cisco.com ទៅអង្គចងចាំពន្លឺរបស់ ASA ។
    • សម្រាប់អតីតampលេ៖ ចម្លង tftp://10.7.0.80/asa-restapi-111-lfbff-k8.SPA disk0៖
  • ជំហានទី 2៖ ចេញថាសរូបភាព rest-api0:/ ពាក្យបញ្ជាដើម្បីផ្ទៀងផ្ទាត់ និងដំឡើងកញ្ចប់។
    • សម្រាប់អតីតampលេ៖ រូបភាព rest-api disk0:/asa-restapi-111-lfbff-k8.SPA

កម្មវិធីដំឡើងនឹងធ្វើការត្រួតពិនិត្យភាពឆបគ្នា និងសុពលភាព ហើយបន្ទាប់មកដំឡើងកញ្ចប់។ ASA នឹងមិនដំណើរការឡើងវិញទេ។

បើកដំណើរការភ្នាក់ងារ REST API

សូមអនុវត្តតាមជំហានទាំងនេះ ដើម្បីបើកដំណើរការ ASA REST API Agent នៅលើ ASA ជាក់លាក់មួយ៖

  • ជំហានទី 1៖ ត្រូវប្រាកដថារូបភាពកម្មវិធីត្រឹមត្រូវត្រូវបានដំឡើងនៅលើ ASA។
  • ជំហានទី 2៖ ដោយប្រើ CLI ត្រូវប្រាកដថាម៉ាស៊ីនមេ HTTP ត្រូវបានបើកនៅលើ ASA ហើយអតិថិជន API អាចភ្ជាប់ទៅចំណុចប្រទាក់គ្រប់គ្រង។
    • សម្រាប់អតីតampលេ៖ បើកម៉ាស៊ីនមេ http
    • http 0.0.0.0 0.0.0.0
  • ជំហានទី 3៖ ដោយប្រើ CLI កំណត់ការផ្ទៀងផ្ទាត់ HTTP សម្រាប់ការតភ្ជាប់ API ។ សម្រាប់អតីតample: ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ aaa http console LOCAL
  • ជំហានទី 4៖ ដោយប្រើ CLI បង្កើតផ្លូវឋិតិវន្តនៅលើ ASA សម្រាប់ចរាចរ API ។ សម្រាប់អតីតample : ផ្លូវ 0.0.0.0 0.0.0.0 ១
  • ជំហានទី 5៖ ដោយប្រើ CLI បើកដំណើរការ ASA REST API Agent នៅលើ ASA ។ សម្រាប់អតីតample: ភ្នាក់ងារ rest-api

ការផ្ទៀងផ្ទាត់ REST API

មានវិធីពីរយ៉ាងក្នុងការផ្ទៀងផ្ទាត់៖ ការផ្ទៀងផ្ទាត់ HTTP មូលដ្ឋាន ដែលឆ្លងកាត់ឈ្មោះអ្នកប្រើប្រាស់ និងពាក្យសម្ងាត់នៅក្នុងរាល់សំណើ ឬការផ្ទៀងផ្ទាត់តាម Token ជាមួយនឹងការដឹកជញ្ជូន HTTPS សុវត្ថិភាព ដែលឆ្លងកាត់និមិត្តសញ្ញាដែលបានបង្កើតពីមុនជាមួយនឹងសំណើនីមួយៗ។ វិធីណាក៏ដោយ ការផ្ទៀងផ្ទាត់នឹងត្រូវបានអនុវត្តសម្រាប់រាល់សំណើ។ សូមមើលផ្នែក “Token_Authentication_API” នៅក្នុងការណែនាំអំពី ASA REST API v7.14(x) សម្រាប់ព័ត៌មានបន្ថែមអំពីការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវផ្អែកលើនិមិត្តសញ្ញា។

ចំណាំ៖ ការប្រើប្រាស់វិញ្ញាបនបត្រដែលចេញដោយអាជ្ញាធរវិញ្ញាបនបត្រ (CA) ត្រូវបានណែនាំនៅលើ ASA ដូច្នេះអតិថិជន REST API អាចផ្តល់សុពលភាពវិញ្ញាបនបត្រម៉ាស៊ីនមេ ASA នៅពេលបង្កើតការតភ្ជាប់ SSL ។

ការអនុញ្ញាតបញ្ជា

ប្រសិនបើការអនុញ្ញាតពាក្យបញ្ជាត្រូវបានកំណត់រចនាសម្ព័ន្ធដើម្បីប្រើម៉ាស៊ីនមេ AAA ខាងក្រៅ (សម្រាប់ឧample, aaa ពាក្យបញ្ជាអនុញ្ញាត ) បន្ទាប់មកអ្នកប្រើប្រាស់ឈ្មោះ enable_1 ត្រូវតែមាននៅលើម៉ាស៊ីនមេដែលមានសិទ្ធិពាក្យបញ្ជាពេញលេញ។ ប្រសិនបើការអនុញ្ញាតពាក្យបញ្ជាត្រូវបានកំណត់រចនាសម្ព័ន្ធដើម្បីប្រើមូលដ្ឋានទិន្នន័យ LOCAL របស់ ASA (បញ្ជាការអនុញ្ញាត aaa LOCAL) នោះអ្នកប្រើប្រាស់ REST API ទាំងអស់ត្រូវតែចុះឈ្មោះក្នុងមូលដ្ឋានទិន្នន័យ LOCAL ជាមួយនឹងកម្រិតសិទ្ធិដែលសមរម្យសម្រាប់តួនាទីរបស់ពួកគេ៖

  • ឯកសិទ្ធិកម្រិត 3 ឬខ្ពស់ជាងនេះ គឺត្រូវបានទាមទារ ដើម្បីស្នើសុំការត្រួតពិនិត្យ។
  • កម្រិតឯកសិទ្ធិ 5 ឬខ្ពស់ជាងនេះគឺត្រូវបានទាមទារសម្រាប់ការហៅសំណើ GET ។
  • កម្រិតសិទ្ធិ 15 គឺចាំបាច់សម្រាប់ការហៅប្រតិបត្តិការ PUT/POST/DELETE។

កំណត់រចនាសម្ព័ន្ធម៉ាស៊ីនភ្ញៀវ REST API របស់អ្នក។

សូមអនុវត្តតាមជំហានទាំងនេះ ដើម្បីដំឡើង និងកំណត់រចនាសម្ព័ន្ធម៉ាស៊ីនភ្ញៀវ REST API នៅលើកម្មវិធីរុករកតាមអ៊ីនធឺណិតម៉ាស៊ីនមូលដ្ឋានរបស់អ្នក៖

  • ជំហានទី 1៖ ទទួលបាន និងដំឡើងម៉ាស៊ីនភ្ញៀវ REST API សម្រាប់កម្មវិធីរុករករបស់អ្នក។
    • សម្រាប់ Chrome សូមដំឡើងម៉ាស៊ីនភ្ញៀវ REST ពី Google ។ សម្រាប់ Firefox សូមដំឡើងកម្មវិធីបន្ថែម RESTClient ។ Internet Explorer មិនត្រូវបានគាំទ្រទេ។
  • ជំហានទី 2៖ ចាប់ផ្តើមសំណើខាងក្រោមដោយប្រើកម្មវិធីរុករករបស់អ្នក៖ https: /api/objects/networkobjects
    • ប្រសិនបើអ្នកទទួលបានការឆ្លើយតបដែលមិនមានកំហុស អ្នកបានទៅដល់ភ្នាក់ងារ REST API ដែលដំណើរការនៅលើ ASA។
    • ប្រសិនបើអ្នកកំពុងមានបញ្ហាជាមួយសំណើភ្នាក់ងារ អ្នកអាចបើកការបង្ហាញព័ត៌មានបំបាត់កំហុសនៅលើកុងសូល CLI ដូចដែលបានពិពណ៌នានៅក្នុងការបើកការបំបាត់កំហុស REST API នៅលើ ASA។
  • ជំហានទី 3៖ ជាជម្រើស អ្នកអាចសាកល្បងការតភ្ជាប់របស់អ្នកទៅ ASA ដោយអនុវត្តប្រតិបត្តិការ POST ។

សម្រាប់អតីតampលេ៖ ផ្តល់លិខិតបញ្ជាក់ការអនុញ្ញាតជាមូលដ្ឋាន ( ) ឬសញ្ញាសម្គាល់ការផ្ទៀងផ្ទាត់ (សូមមើល Token Authentication សម្រាប់ព័ត៌មានបន្ថែម)។

  • អាសយដ្ឋានស្នើសុំគោលដៅ៖ https://<asa management ipaddress>/api/objects/networkobjects
  • ប្រភេទមាតិការាងកាយ៖ កម្មវិធី/json

រាងកាយឆៅនៃប្រតិបត្តិការ៖

CISCO-ASA-REST-API-App-fig-2

ឥឡូវនេះអ្នកអាចប្រើ ASA REST API ដើម្បីកំណត់រចនាសម្ព័ន្ធ និងត្រួតពិនិត្យ ASA ។ យោងឯកសារ API សម្រាប់ការពិពណ៌នាការហៅទូរសព្ទ និងឧamples ។

អំពីការស្តារការកំណត់រចនាសម្ព័ន្ធបម្រុងទុកពេញលេញ

ការស្ដារការកំណត់រចនាសម្ព័ន្ធបម្រុងទុកពេញលេញនៅលើ ASA ដោយប្រើ REST API នឹងផ្ទុក ASA ឡើងវិញ។ ដើម្បីជៀសវាងបញ្ហានេះ សូមប្រើពាក្យបញ្ជាខាងក្រោមដើម្បីស្ដារការកំណត់រចនាសម្ព័ន្ធបម្រុងទុក៖

  • {
    • “commands”:[“copy /noconfirm disk0:/fileឈ្មោះ> ដំណើរការ-កំណត់រចនាសម្ព័ន្ធ”]
  • }
    • កន្លែងណាfilename> គឺ backup.cfg ឬឈ្មោះអ្វីក៏ដោយដែលអ្នកបានប្រើនៅពេលបម្រុងទុកការកំណត់រចនាសម្ព័ន្ធ។

កុងសូលឯកសារ និងការនាំចេញស្គ្រីប API

អ្នកក៏អាចប្រើកុងសូលឯកសារលើបណ្តាញ REST API (ហៅថា "Doc UI") ដែលមាននៅ host:port/doc/ ជា "sandbox" សម្រាប់ស្វែងយល់ និងសាកល្បងការហៅ API ដោយផ្ទាល់នៅលើ ASA។ លើសពីនេះ អ្នកអាចប្រើប៊ូតុងប្រតិបត្តិការនាំចេញនៅក្នុង Doc UI ដើម្បីរក្សាទុកវិធីសាស្ត្រដែលបានបង្ហាញ ឧample ជា JavaScript, Python, ឬ Perl script file ដល់ម្ចាស់ផ្ទះក្នុងតំបន់របស់អ្នក។ បន្ទាប់មក អ្នកអាចអនុវត្តស្គ្រីបនេះទៅ ASA របស់អ្នក ហើយកែសម្រួលវាសម្រាប់កម្មវិធីនៅលើ ASAs និងឧបករណ៍បណ្តាញផ្សេងទៀត។ នេះមានន័យថាជាចម្បងជាឧបករណ៍អប់រំ និងចាប់ផ្ដើមប្រព័ន្ធ។

JavaScript

  • ការប្រើប្រាស់ JavaScript file ទាមទារការដំឡើង node.js ដែលអាចត្រូវបានរកឃើញនៅ http://nodejs.org/.
  • ដោយប្រើ node.js អ្នកអាចប្រតិបត្តិ JavaScript fileជាធម្មតាត្រូវបានសរសេរសម្រាប់កម្មវិធីរុករក ដូចជាស្គ្រីបបន្ទាត់ពាក្យបញ្ជា។ គ្រាន់តែធ្វើតាមការណែនាំអំពីការដំឡើង ហើយបន្ទាប់មកដំណើរការស្គ្រីបរបស់អ្នកជាមួយ node script.js។

ពស់ថ្លាន់

  • ស្គ្រីប Python តម្រូវឱ្យអ្នកដំឡើង Python ដែលអាចរកបានពី https://www.python.org/.
  • នៅពេលដែលអ្នកបានដំឡើង Python អ្នកអាចដំណើរការស្គ្រីបរបស់អ្នកដោយប្រើពាក្យសម្ងាត់ឈ្មោះអ្នកប្រើ python script.py ។

Perl

ការប្រើប្រាស់ស្គ្រីប Perl ទាមទារការដំឡើងបន្ថែមមួយចំនួន - អ្នកត្រូវការសមាសធាតុចំនួនប្រាំ៖ Perl ខ្លួនវា និងបណ្ណាល័យ Perl ចំនួនបួន៖

នេះគឺជាអតីតample នៃការ bootstrapping Perl នៅលើ Macintosh:

  • $ sudo perl -MCPAN អ៊ីសែល
  • cpan> ដំឡើងកញ្ចប់ ::CPAN
  • cpan> ដំឡើង REST :: អតិថិជន
  • cpan> ដំឡើង MIME៖៖ មូលដ្ឋាន 64
  • cpan> ដំឡើង JSON

បន្ទាប់ពីដំឡើងភាពអាស្រ័យ អ្នកអាចដំណើរការស្គ្រីបរបស់អ្នកដោយប្រើ perl script.pl username password។

បើកដំណើរការការបំបាត់កំហុស REST API នៅលើ ASA

ប្រសិនបើអ្នកមានបញ្ហាក្នុងការកំណត់រចនាសម្ព័ន្ធ ឬភ្ជាប់ទៅ REST API នៅលើ ASA អ្នកអាចប្រើពាក្យបញ្ជា CLI ខាងក្រោមដើម្បីបើកការបង្ហាញសារបំបាត់កំហុសនៅលើកុងសូលរបស់អ្នក។ ប្រើទម្រង់គ្មានពាក្យបញ្ជា ដើម្បីបិទសារបំបាត់កំហុស។
debug rest-api [ភ្នាក់ងារ | គ្លី | អតិថិជន | ដេមិន | ដំណើរការ | token-auth] [error | ព្រឹត្តិការណ៍] គ្មានការបំបាត់កំហុស rest-api

ការពិពណ៌នាវាក្យសម្ព័ន្ធ

  • ភ្នាក់ងារ៖ (ជាជម្រើស) បើកដំណើរការព័ត៌មានបំបាត់កំហុសភ្នាក់ងារ REST API ។
  • គ្លីនិក៖ (ជាជម្រើស) បើកដំណើរការសារបំបាត់កំហុសសម្រាប់ការទំនាក់ទំនង REST API CLI Daemon-to-Agent ។
  • អតិថិជន៖ (ជាជម្រើស) បើកដំណើរការព័ត៌មានបំបាត់កំហុសសម្រាប់ការបញ្ជូនសាររវាងម៉ាស៊ីនភ្ញៀវ REST API និងភ្នាក់ងារ REST API ។
  • ដេមិន៖ (ជាជម្រើស) បើកដំណើរការសារបំបាត់កំហុសសម្រាប់ការទំនាក់ទំនង REST API Daemon-to-Agent ។
  • ដំណើរការ៖ (ជាជម្រើស) បើកដំណើរការភ្នាក់ងារ REST API ចាប់ផ្តើម/បញ្ឈប់ព័ត៌មានបំបាត់កំហុស។
  • សញ្ញាសម្ងាត់៖ (ជាជម្រើស) ព័ត៌មានបំបាត់កំហុសការផ្ទៀងផ្ទាត់សញ្ញាសម្គាល់ REST API ។
  • កំហុស៖ (ជាជម្រើស) ប្រើពាក្យគន្លឹះនេះដើម្បីកំណត់សារបំបាត់កំហុសចំពោះតែកំហុសដែលបានកត់ត្រាដោយ API ប៉ុណ្ណោះ។
  • ព្រឹត្តិការណ៍៖ (ជាជម្រើស) ប្រើពាក្យគន្លឹះនេះដើម្បីកំណត់សារបំបាត់កំហុសចំពោះតែព្រឹត្តិការណ៍ដែលបានកត់ត្រាដោយ API ប៉ុណ្ណោះ។

ការណែនាំអំពីការប្រើប្រាស់

ប្រសិនបើអ្នកមិនផ្តល់ពាក្យគន្លឹះសមាសភាគជាក់លាក់ (នោះគឺប្រសិនបើអ្នកគ្រាន់តែចេញពាក្យបញ្ជាបំបាត់កំហុស rest-api) សារបំបាត់កំហុសត្រូវបានបង្ហាញសម្រាប់ប្រភេទសមាសភាគទាំងអស់។ ប្រសិនបើអ្នកមិនផ្តល់ពាក្យគន្លឹះព្រឹត្តិការណ៍ ឬកំហុសទេ ទាំងព្រឹត្តិការណ៍ និងសារកំហុសត្រូវបានបង្ហាញសម្រាប់សមាសភាគដែលបានបញ្ជាក់។ សម្រាប់អតីតample, debug rest-api daemon event នឹងបង្ហាញតែសារបំបាត់កំហុសព្រឹត្តិការណ៍សម្រាប់ការទំនាក់ទំនង API Daemon-to-Agent។

ពាក្យបញ្ជាដែលពាក់ព័ន្ធ

ពាក្យបញ្ជា / ការពិពណ៌នា

  • បំបាត់កំហុស HTTP; ប្រើពាក្យបញ្ជានេះដើម្បី view ព័ត៌មានលំអិតអំពីចរាចរណ៍ HTTP ។

សារ Syslog ទាក់ទងនឹង ASA REST API

សារកំណត់ហេតុប្រព័ន្ធទាក់ទងនឹង ASA REST API ត្រូវបានពិពណ៌នានៅក្នុងផ្នែកនេះ។

342001

  • សារកំហុស៖ %ASA-7-342001៖ ភ្នាក់ងារ REST API បានចាប់ផ្តើមដោយជោគជ័យ។
    • ការពន្យល់៖ ភ្នាក់ងារ REST API ត្រូវតែចាប់ផ្តើមដោយជោគជ័យ មុនពេលអតិថិជន REST API អាចកំណត់រចនាសម្ព័ន្ធ ASA ។
    • សកម្មភាពដែលបានណែនាំ៖ គ្មាន។

342002

  • សារកំហុស៖ %ASA-3-342002៖ ភ្នាក់ងារ REST API បានបរាជ័យ ហេតុផល៖ ហេតុផល
    • ការពន្យល់៖ ភ្នាក់ងារ REST API អាចបរាជ័យក្នុងការចាប់ផ្តើម ឬគាំងដោយសារហេតុផលផ្សេងៗ ហើយហេតុផលត្រូវបានបញ្ជាក់។
    • ហេតុផល - មូលហេតុនៃការបរាជ័យ REST API

សកម្មភាពដែលបានណែនាំ៖ សកម្មភាពដែលបានធ្វើឡើងដើម្បីដោះស្រាយបញ្ហាប្រែប្រួលអាស្រ័យលើហេតុផលដែលបានកត់ត្រា។ សម្រាប់អតីតampដូច្នេះ ភ្នាក់ងារ REST API គាំងនៅពេលដំណើរការ Java អស់អង្គចងចាំ។ ប្រសិនបើវាកើតឡើង អ្នកត្រូវចាប់ផ្តើម REST API Agent ឡើងវិញ។ ប្រសិនបើការចាប់ផ្តើមឡើងវិញមិនជោគជ័យ សូមទាក់ទង Cisco TAC ដើម្បីកំណត់អត្តសញ្ញាណការដោះស្រាយបញ្ហាឫសគល់។

342003

  • សារកំហុស៖ %ASA-3-342003៖ បានទទួលការជូនដំណឹងអំពីការបរាជ័យរបស់ភ្នាក់ងារ REST API ។ ភ្នាក់ងារនឹងត្រូវបានចាប់ផ្តើមឡើងវិញដោយស្វ័យប្រវត្តិ។
    • ការពន្យល់៖ ការជូនដំណឹងអំពីការបរាជ័យពីភ្នាក់ងារ REST API ត្រូវបានទទួល ហើយការចាប់ផ្តើមឡើងវិញនៃភ្នាក់ងារកំពុងត្រូវបានព្យាយាម។
    • សកម្មភាពដែលបានណែនាំ៖ គ្មាន។

342004

  • សារកំហុស៖ %ASA-3-342004៖ បានបរាជ័យក្នុងការចាប់ផ្តើមភ្នាក់ងារ REST API ឡើងវិញដោយស្វ័យប្រវត្តិបន្ទាប់ពីការព្យាយាមមិនបានសម្រេចចំនួន 5 ដង។ ប្រើពាក្យបញ្ជា 'no rest-api agent' និង 'rest-api agent' ដើម្បីចាប់ផ្តើមភ្នាក់ងារឡើងវិញដោយដៃ។
    • ការពន្យល់៖ ភ្នាក់ងារ REST API បានបរាជ័យក្នុងការចាប់ផ្តើមបន្ទាប់ពីការព្យាយាមជាច្រើន។
    • សកម្មភាពដែលបានណែនាំ៖ សូមមើល syslog %ASA-3-342002 (ប្រសិនបើបានចូល) ដើម្បីយល់កាន់តែច្បាស់អំពីហេតុផលនៅពីក្រោយការបរាជ័យ។ ព្យាយាមបិទភ្នាក់ងារ REST API ដោយបញ្ចូលពាក្យបញ្ជា no rest-api agent ហើយបើកដំណើរការ REST API Agent ឡើងវិញដោយប្រើពាក្យបញ្ជាភ្នាក់ងារ rest-api ។

ឯកសារពាក់ព័ន្ធ

ប្រើតំណខាងក្រោមដើម្បីស្វែងរកព័ត៌មានបន្ថែមអំពី ASA និងការកំណត់រចនាសម្ព័ន្ធ និងការគ្រប់គ្រងរបស់វា៖

ឯកសារនេះត្រូវប្រើដោយភ្ជាប់ជាមួយឯកសារដែលមានពីផ្នែក "ឯកសារពាក់ព័ន្ធ"។
Cisco និងនិមិត្តសញ្ញា Cisco គឺជាពាណិជ្ជសញ្ញា ឬពាណិជ្ជសញ្ញាដែលបានចុះបញ្ជីរបស់ Cisco និង/ឬសាខារបស់ខ្លួននៅក្នុងសហរដ្ឋអាមេរិក និងប្រទេសដទៃទៀត។ ទៅ view បញ្ជីនៃពាណិជ្ជសញ្ញា Cisco សូមចូលទៅកាន់នេះ។ URL: www.cisco.com/go/trademarks ។. ពាណិជ្ជសញ្ញាភាគីទីបីដែលបានលើកឡើងគឺជាទ្រព្យសម្បត្តិរបស់ម្ចាស់រៀងៗខ្លួន។ ការប្រើប្រាស់ពាក្យថាដៃគូរមិនមានន័យថាទំនាក់ទំនងភាពជាដៃគូរវាង Cisco និងក្រុមហ៊ុនណាមួយផ្សេងទៀតនោះទេ។ (1721R)
អាសយដ្ឋាន និងលេខទូរស័ព្ទនៃពិធីការអ៊ីនធឺណិត (IP) ណាមួយដែលប្រើក្នុងឯកសារនេះមិនមានបំណងជាអាសយដ្ឋាន និងលេខទូរស័ព្ទពិតប្រាកដនោះទេ។ អតីតamples, command display output, network topology diagrams និង​តួលេខ​ផ្សេង​ទៀត​ដែល​រួម​បញ្ចូល​ក្នុង​ឯកសារ​ត្រូវ​បាន​បង្ហាញ​ក្នុង​គោល​បំណង​ជា​ឧទាហរណ៍​ប៉ុណ្ណោះ។
រាល់ការប្រើប្រាស់អាសយដ្ឋាន IP ពិតប្រាកដ ឬលេខទូរស័ព្ទនៅក្នុងខ្លឹមសាររូបភាពគឺអចេតនា និងចៃដន្យ។

Cisco Systems, Inc.

© 2014-2018 Cisco Systems, Inc. រក្សាសិទ្ធិគ្រប់យ៉ាង។

ឯកសារ/ធនធាន

កម្មវិធី CISCO ASA REST API [pdf] ការណែនាំអ្នកប្រើប្រាស់
កម្មវិធី ASA REST API, ASA, REST API App, API App, App

ឯកសារយោង

ទុកមតិយោបល់

អាសយដ្ឋានអ៊ីមែលរបស់អ្នកនឹងមិនត្រូវបានផ្សព្វផ្សាយទេ។ វាលដែលត្រូវការត្រូវបានសម្គាល់ *