Εφαρμογή CISCO ASA REST API

Οδηγίες χρήσης προϊόντος

Υπερview

Με την κυκλοφορία του API REST της Cisco, έχετε τώρα μια άλλη ελαφριά, εύχρηστη επιλογή για τη διαμόρφωση και τη διαχείριση μεμονωμένων Cisco ASA. Το 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 σάς παρέχει πρόσβαση μέσω προγραμματισμού για τη διαχείριση μεμονωμένων ASA μέσω ενός API μεταφοράς αντιπροσωπευτικής κατάστασης (REST). Το API επιτρέπει σε εξωτερικούς πελάτες να εκτελούν λειτουργίες CRUD (Δημιουργία, Ανάγνωση, Ενημέρωση, Διαγραφή) σε πόρους ASA. Όλα τα αιτήματα API αποστέλλονται μέσω HTTPS στο ASA και επιστρέφεται μια απάντηση.

όπου οι ιδιότητες του αντικειμένου είναι:

Ιδιοκτησία	Τύπος	Περιγραφή
μηνύματα	Κατάλογος λεξικών	Λίστα σφαλμάτων ή προειδοποιητικών μηνυμάτων
κώδικας	Σειρά	Αναλυτικό μήνυμα που αντιστοιχεί σε Σφάλμα/Προειδοποίηση/Πληροφορίες
καθέκαστα	Σειρά	Αναλυτικό μήνυμα που αντιστοιχεί σε Σφάλμα/Προειδοποίηση/Πληροφορίες

Σημείωμα: Οι αλλαγές που πραγματοποιούνται από κλήσεις REST API δεν παραμένουν στη διαμόρφωση εκκίνησης, αλλά εκχωρούνται μόνο στη διαμόρφωση που εκτελείται. Για να αποθηκεύσετε τις αλλαγές στη διαμόρφωση εκκίνησης, μπορείτε να χρησιμοποιήσετε το αίτημα API POST a write mem. Για περισσότερες πληροφορίες, ανατρέξτε στην καταχώρηση Write Memory API στον πίνακα περιεχομένων About the ASA REST API.

Εγκαταστήστε και διαμορφώστε τον ASA REST API Agent and Client

Σημείωμα: Το REST API Agent είναι μια εφαρμογή που βασίζεται σε Java. Το Java Runtime Environment (JRE) περιλαμβάνεται στο πακέτο REST API Agent.

Υπερview

Διατίθενται αρκετές επιλογές για τη διαμόρφωση και τη διαχείριση μεμονωμένων Cisco ASA:

• Διεπαφή γραμμής εντολών (CLI) – στέλνετε εντολές ελέγχου απευθείας στο ASA μέσω μιας συνδεδεμένης κονσόλας.
• Adaptive Security Device Manager (ASDM) – μια εφαρμογή διαχείρισης "on-box" με γραφικό περιβάλλον χρήστη που μπορείτε να χρησιμοποιήσετε για να διαμορφώσετε, να διαχειριστείτε και να παρακολουθήσετε ένα ASA.
• Cisco Security Manager – ενώ προορίζεται για μεσαία έως μεγάλα δίκτυα πολλών συσκευών ασφαλείας, αυτή η γραφική εφαρμογή μπορεί να χρησιμοποιηθεί για τη διαμόρφωση, διαχείριση και παρακολούθηση μεμονωμένων ASA.

Με την κυκλοφορία του 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 σάς παρέχει πρόσβαση μέσω προγραμματισμού για τη διαχείριση μεμονωμένων ASA μέσω ενός API Representational State Transfer (REST). Το API επιτρέπει σε εξωτερικούς πελάτες να εκτελούν λειτουργίες CRUD (Δημιουργία, Ανάγνωση, Ενημέρωση, Διαγραφή) σε πόρους ASA. βασίζεται στο πρωτόκολλο HTTPS και στη μεθοδολογία REST. Όλα τα αιτήματα API αποστέλλονται μέσω HTTPS στο ASA και επιστρέφεται μια απάντηση. Αυτή η ενότητα παρέχει ένα overview για το πώς δομούνται τα αιτήματα και τις αναμενόμενες απαντήσεις,

Δομή αιτήματος

Οι διαθέσιμες μέθοδοι αιτήματος είναι:

• GET – Ανακτά δεδομένα από το καθορισμένο αντικείμενο.
• PUT – Προσθέτει τις παρεχόμενες πληροφορίες στο καθορισμένο αντικείμενο. επιστρέφει ένα σφάλμα 404 Resource Not Found εάν το αντικείμενο δεν υπάρχει.
• POST – Δημιουργεί το αντικείμενο με τις παρεχόμενες πληροφορίες.
• DELETE – Διαγράφει το καθορισμένο αντικείμενο.
• PATCH – Εφαρμόζει μερικές τροποποιήσεις στο καθορισμένο αντικείμενο.

Δομή απόκρισης

• Κάθε αίτημα παράγει μια απάντηση HTTPS από το ASA με τις τυπικές κεφαλίδες, το περιεχόμενο απόκρισης και τον κωδικό κατάστασης.

Η δομή απόκρισης μπορεί να είναι:

• ΤΟΠΟΘΕΣΙΑ – Αναγνωριστικό πόρου που δημιουργήθηκε πρόσφατα. μόνο για POST—κρατά το νέο αναγνωριστικό πόρου (ως αναπαράσταση URI).
• CONTENT-TYPE – Τύπος μέσου που περιγράφει το σώμα του μηνύματος απάντησης. περιγράφει την αναπαράσταση και τη σύνταξη του σώματος του μηνύματος απάντησης.

Κάθε απάντηση περιλαμβάνει μια κατάσταση HTTP ή έναν κωδικό σφάλματος. Οι διαθέσιμοι κωδικοί εμπίπτουν σε αυτές τις κατηγορίες:

• 20x – Ένας κωδικός σειράς διακόσιων υποδηλώνει επιτυχή λειτουργία, συμπεριλαμβανομένων:
  • 200 OK – Τυπική απάντηση για επιτυχημένα αιτήματα.
  • 201 Δημιουργήθηκε – Το αίτημα ολοκληρώθηκε. δημιουργήθηκε νέος πόρος.
  • 202 Αποδεκτό – Το αίτημα έγινε δεκτό, αλλά η επεξεργασία δεν ολοκληρώθηκε.
  • 204 Χωρίς περιεχόμενο – Ο διακομιστής επεξεργάστηκε επιτυχώς το αίτημα. κανένα περιεχόμενο δεν επιστρέφεται.
• 4xx – Ένας κωδικός σειράς τετρακοσίων υποδηλώνει σφάλμα από την πλευρά του πελάτη, συμπεριλαμβανομένων:
  • 400 Bad Request – Μη έγκυρες παράμετροι ερωτήματος, συμπεριλαμβανομένων μη αναγνωρισμένων παραμέτρων, παραμέτρων που λείπουν ή μη έγκυρων τιμών.
  • 404 Δεν βρέθηκε – Το παρεχόμενο URL δεν ταιριάζει με έναν υπάρχοντα πόρο. Για π.χampΛοιπόν, ένα HTTP DELETE μπορεί να αποτύχει επειδή ο πόρος δεν είναι διαθέσιμος.
  • 405 Μέθοδος δεν επιτρέπεται – Παρουσιάστηκε ένα αίτημα HTTP που δεν επιτρέπεται στον πόρο. για π.χample, ένα POST σε έναν πόρο μόνο για ανάγνωση.
• 5xx – Ένας κωδικός σειράς πεντακοσίων υποδηλώνει σφάλμα από την πλευρά του διακομιστή.

Σε περίπτωση σφάλματος, εκτός από τον κωδικό σφάλματος, η απάντηση επιστροφής μπορεί να περιλαμβάνει ένα αντικείμενο σφάλματος που περιέχει περισσότερες λεπτομέρειες σχετικά με το σφάλμα. Το σχήμα απάντησης σφάλματος/προειδοποίησης JSON έχει ως εξής:

όπου οι ιδιότητες του αντικειμένου είναι:

Ιδιοκτησία	Τύπος	Περιγραφή
μηνύματα	Κατάλογος λεξικών	Λίστα σφαλμάτων ή προειδοποιητικών μηνυμάτων
κώδικας	Σειρά	Κωδικός σφάλματος/προειδοποίησης/πληροφοριών
καθέκαστα	Σειρά	Αναλυτικό μήνυμα που αντιστοιχεί σε Σφάλμα/Προειδοποίηση/Πληροφορίες

Σημείωμα: Οι αλλαγές στη διαμόρφωση ASA που πραγματοποιούνται από κλήσεις REST API δεν παραμένουν στη διαμόρφωση εκκίνησης. Δηλαδή, οι αλλαγές αντιστοιχίζονται μόνο στην τρέχουσα διαμόρφωση. Για να αποθηκεύσετε τις αλλαγές στη διαμόρφωση εκκίνησης, μπορείτε να ΑΝΑΡΤΗΣΕΤΕ ένα αίτημα API writemem. για περισσότερες πληροφορίες, ακολουθήστε την καταχώρηση "Write Memory API" στον πίνακα περιεχομένων Σχετικά με το ASA REST API.

Εγκαταστήστε και διαμορφώστε τον ASA REST API Agent and Client

• Το REST API Agent δημοσιεύεται μεμονωμένα με άλλες εικόνες ASA cisco.com. Για τα φυσικά ASA, το πακέτο REST API πρέπει να ληφθεί στο flash της συσκευής και να εγκατασταθεί χρησιμοποιώντας την εντολή "rest-api image". Στη συνέχεια, ο παράγοντας REST API ενεργοποιείται χρησιμοποιώντας την εντολή "rest-api agent".
• Με ένα εικονικό ASA (ASAv), η εικόνα REST API πρέπει να ληφθεί στο διαμέρισμα "boot:". Στη συνέχεια, πρέπει να εκδώσετε την εντολή "rest-api image", ακολουθούμενη από την εντολή "rest-api agent", για να αποκτήσετε πρόσβαση και να ενεργοποιήσετε τον παράγοντα REST API.
• Για πληροφορίες σχετικά με τις απαιτήσεις λογισμικού και υλικού REST API και τη συμβατότητα, ανατρέξτε στον πίνακα συμβατότητας Cisco ASA.
• Μπορείτε να κάνετε λήψη του κατάλληλου πακέτου REST API για το ASA ή το ASAv σας από software.cisco.com/download/home. Εντοπίστε το συγκεκριμένο μοντέλο Adaptive Security Appliances (ASA) και, στη συνέχεια, επιλέξτε Προσθήκη API REST Adaptive Security Appliance.

Σημείωμα: Το REST API Agent είναι μια εφαρμογή που βασίζεται σε 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 ενδέχεται να αρχίσουν να αποτυγχάνουν με 500 – μηνύματα σφάλματος εσωτερικού διακομιστή και το Rest API Agent θα επανεκκινείται αυτόματα κάθε φορά. Οι λύσεις σε αυτήν την κατάσταση είναι είτε μετακίνηση σε πλατφόρμες ASA/FPR ή ASAV υψηλότερης μνήμης ή μείωση του μεγέθους της διαμόρφωσης που εκτελείται.

Λήψη και εγκατάσταση του REST API Agent

Χρησιμοποιώντας το CLI, ακολουθήστε αυτά τα βήματα για να κάνετε λήψη και εγκατάσταση του πράκτορα ASA REST API σε ένα συγκεκριμένο ASA:

• Βήμα 1: Στο επιθυμητό ASA, εκδώστε το αντίγραφο disk0: εντολή για λήψη του τρέχοντος πακέτου ASA REST API από cisco.com στη μνήμη flash του ASA.
  • Για π.χample: αντιγράψτε tftp://10.7.0.80/asa-restapi-111-lfbff-k8.SPA disk0:
• Βήμα 2: Έκδοση του δίσκου εικόνας rest-api0:/ εντολή για επαλήθευση και εγκατάσταση του πακέτου.
  • Για π.χample: rest-api image disk0:/asa-restapi-111-lfbff-k8.SPA

Το πρόγραμμα εγκατάστασης θα εκτελέσει ελέγχους συμβατότητας και επικύρωσης και, στη συνέχεια, θα εγκαταστήσει το πακέτο. Το ASA δεν θα επανεκκινήσει.

Ενεργοποιήστε το REST API Agent

Ακολουθήστε αυτά τα βήματα για να ενεργοποιήσετε τον ASA REST API Agent σε ένα συγκεκριμένο ASA:

• Βήμα 1: Βεβαιωθείτε ότι η σωστή εικόνα λογισμικού είναι εγκατεστημένη στο ASA.
  • Συμβουλευτείτε την ενότητα REST API του ASA Compatibility Matrix (https://www.cisco.com/c/en/us/td/docs/security/asa/compatibility/asamatrx.html#pgfId-131643) για να προσδιορίσετε ποια εικόνα ASA απαιτείται.
• Βήμα 2: Χρησιμοποιώντας το CLI, βεβαιωθείτε ότι ο διακομιστής HTTP είναι ενεργοποιημένος στο ASA και ότι οι πελάτες API μπορούν να συνδεθούν στη διεπαφή διαχείρισης.
  • Για π.χample: Ενεργοποίηση διακομιστή http
  • http 0.0.0.0 0.0.0.0
• Βήμα 3: Χρησιμοποιώντας το CLI, ορίστε τον έλεγχο ταυτότητας HTTP για τις συνδέσεις API. Για π.χample: aaa έλεγχος ταυτότητας http κονσόλα LOCAL
• Βήμα 4: Χρησιμοποιώντας το CLI, δημιουργήστε μια στατική διαδρομή στο ASA για την κυκλοφορία API. Για π.χample: διαδρομή 0.0.0.0 0.0.0.0 1
• Βήμα 5: Χρησιμοποιώντας το CLI, ενεργοποιήστε τον ASA REST API Agent στο ASA. Για π.χample: rest-api agent

REST API Έλεγχος ταυτότητας

Υπάρχουν δύο τρόποι για τον έλεγχο ταυτότητας: Βασικός έλεγχος ταυτότητας HTTP, ο οποίος μεταβιβάζει ένα όνομα χρήστη και κωδικό πρόσβασης σε κάθε αίτημα ή έλεγχος ταυτότητας βάσει διακριτικών με ασφαλή μεταφορά HTTPS, που μεταβιβάζει ένα διακριτικό που δημιουργήθηκε προηγουμένως με κάθε αίτημα. Σε κάθε περίπτωση, ο έλεγχος ταυτότητας θα εκτελείται για κάθε αίτημα. Ανατρέξτε στην ενότητα "Token_Authentication_API" στον οδηγό Σχετικά με το ASA REST API v7.14(x) για πρόσθετες πληροφορίες σχετικά με τον έλεγχο ταυτότητας που βασίζεται σε Token.

Σημείωμα: Η χρήση πιστοποιητικών που έχουν εκδοθεί από την αρχή έκδοσης πιστοποιητικών (CA) συνιστάται στο ASA, επομένως οι πελάτες REST API μπορούν να επικυρώσουν τα πιστοποιητικά διακομιστή ASA κατά τη δημιουργία συνδέσεων SSL.

Εξουσιοδότηση εντολής

Εάν η εξουσιοδότηση εντολών έχει ρυθμιστεί να χρησιμοποιεί έναν εξωτερικό διακομιστή AAA (π.χample, aaa εντολή εξουσιοδότησης ), τότε ένας χρήστης με το όνομα enable_1 πρέπει να υπάρχει σε αυτόν τον διακομιστή με πλήρη δικαιώματα εντολών. Εάν η εξουσιοδότηση εντολών έχει ρυθμιστεί ώστε να χρησιμοποιεί την ΤΟΠΙΚΗ βάση δεδομένων της ASA (ααα εντολή εξουσιοδότησης 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.

Για π.χample: Παρέχετε βασικά διαπιστευτήρια εξουσιοδότησης ( ), ή ένα διακριτικό ελέγχου ταυτότητας (δείτε Έλεγχος ταυτότητας για πρόσθετες πληροφορίες).

• Διεύθυνση αιτήματος στόχου: https://<asa management ipaddress>/api/objects/networkobjects
• Τύπος περιεχομένου σώματος: εφαρμογή/json

Ακατέργαστο σώμα της επέμβασης:

Τώρα μπορείτε να χρησιμοποιήσετε το API REST για να διαμορφώσετε και να παρακολουθήσετε το ASA. Ανατρέξτε στην τεκμηρίωση του API για περιγραφές κλήσεων και π.χamples.

Σχετικά με την πλήρη επαναφορά μιας διαμόρφωσης αντιγράφων ασφαλείας

Η επαναφορά μιας πλήρους διαμόρφωσης αντιγράφων ασφαλείας στο ASA χρησιμοποιώντας το REST API θα φορτώσει ξανά το ASA. Για να αποφύγετε αυτό, χρησιμοποιήστε την ακόλουθη εντολή για να επαναφέρετε μια διαμόρφωση αντιγράφων ασφαλείας:

• {
  • "εντολές":["copy /noconfirm disk0:/fileόνομα> running-config”]
• }
  • Οπουfilename> είναι το backup.cfg ή οποιοδήποτε όνομα χρησιμοποιήσατε κατά τη δημιουργία αντιγράφων ασφαλείας της διαμόρφωσης.

Κονσόλα τεκμηρίωσης και εξαγωγή σεναρίων API

Μπορείτε επίσης να χρησιμοποιήσετε την ηλεκτρονική κονσόλα τεκμηρίωσης REST API (αναφέρεται ως "Διεπαφή χρήστη εγγράφου"), που είναι διαθέσιμη στο host:port/doc/ ως "περιβάλλον δοκιμών" για να μάθετε και να δοκιμάσετε τις κλήσεις API απευθείας στο ASA. Επιπλέον, μπορείτε να χρησιμοποιήσετε το κουμπί Λειτουργία εξαγωγής στη διεπαφή χρήστη Doc για να αποθηκεύσετε την εμφανιζόμενη μέθοδο π.χample ως σενάριο JavaScript, Python ή Perl file στον τοπικό οικοδεσπότη σας. Στη συνέχεια, μπορείτε να εφαρμόσετε αυτό το σενάριο στο ASA σας και να το επεξεργαστείτε για εφαρμογή σε άλλα ASA και άλλες συσκευές δικτύου. Αυτό σήμαινε κυρίως ως εκπαιδευτικό εργαλείο και εργαλείο εκκίνησης.

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:

• Πακέτο Perl, που βρέθηκε στο 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
• ΜΙΜΟΣ::Base64, που βρέθηκε στο http://perldoc.perl.org/MIME/Base64.html
• JSON, βρέθηκε στο http://search.cpan.org/~makamaka/JSON-2.90/lib/JSON.pm

Εδώ είναι ένας πρώηνampLe of bootstrapping Perl σε Macintosh:

• $ sudo perl -MCPAN e shell
• cpan> install Bundle::CPAN
• cpan> εγκατάσταση REST:: Πελάτης
• cpan> εγκατάσταση MIME::Βάση64
• cpan> εγκατάσταση JSON

Μετά την εγκατάσταση των εξαρτήσεων, μπορείτε να εκτελέσετε το σενάριό σας χρησιμοποιώντας τον κωδικό πρόσβασης ονόματος χρήστη perl script.pl.

Ενεργοποίηση εντοπισμού σφαλμάτων REST API στο ASA

Εάν αντιμετωπίζετε προβλήματα με τη διαμόρφωση ή τη σύνδεση με το REST API στο ASA, μπορείτε να χρησιμοποιήσετε την ακόλουθη εντολή CLI για να ενεργοποιήσετε την εμφάνιση των μηνυμάτων εντοπισμού σφαλμάτων στην κονσόλα σας. Χρησιμοποιήστε τη μορφή no της εντολής για να απενεργοποιήσετε τα μηνύματα εντοπισμού σφαλμάτων.
εντοπισμός σφαλμάτων rest-api [πράκτορας | cli | πελάτης | δαίμονας | διαδικασία | token-auth] [σφάλμα | συμβάν] δεν υπάρχει rest-api εντοπισμού σφαλμάτων

Περιγραφή σύνταξης

• μέσο: (Προαιρετικό) Ενεργοποίηση πληροφοριών εντοπισμού σφαλμάτων REST API Agent.
• cli: (Προαιρετικό) Ενεργοποίηση μηνυμάτων εντοπισμού σφαλμάτων για επικοινωνίες REST API CLI Daemon-to-Agent.
• πελάτης: (Προαιρετικό) Ενεργοποίηση πληροφοριών εντοπισμού σφαλμάτων για τη δρομολόγηση μηνυμάτων μεταξύ του προγράμματος-πελάτη REST API και του παράγοντα REST API.
• δαίμονας: (Προαιρετικό) Ενεργοποίηση μηνυμάτων εντοπισμού σφαλμάτων για επικοινωνίες REST API Daemon-to-Agent.
• διαδικασία: (Προαιρετικό) Ενεργοποίηση REST API Agent πληροφοριών έναρξης/διακοπής διεργασίας εντοπισμού σφαλμάτων.
• token-auth: (Προαιρετικό) Πληροφορίες εντοπισμού σφαλμάτων ελέγχου ταυτότητας διακριτικού REST API.
• σφάλμα: (Προαιρετικό) Χρησιμοποιήστε αυτήν τη λέξη-κλειδί για να περιορίσετε τα μηνύματα εντοπισμού σφαλμάτων μόνο σε σφάλματα που καταγράφονται από το API.
• συμβάν: (Προαιρετικό) Χρησιμοποιήστε αυτήν τη λέξη-κλειδί για να περιορίσετε τα μηνύματα εντοπισμού σφαλμάτων μόνο σε συμβάντα που καταγράφονται από το API.

Οδηγίες χρήσης

Εάν δεν παρέχετε μια συγκεκριμένη λέξη-κλειδί στοιχείου (δηλαδή, εάν εκδώσετε απλώς την εντολή εντοπισμού σφαλμάτων rest-api), εμφανίζονται μηνύματα εντοπισμού σφαλμάτων για όλους τους τύπους στοιχείων. Εάν δεν παρέχετε ούτε το συμβάν ούτε τη λέξη-κλειδί σφάλματος, εμφανίζονται μηνύματα συμβάντος και σφάλματος για το καθορισμένο στοιχείο. Για π.χample, το συμβάν εντοπισμού σφαλμάτων rest-api daemon θα εμφανίζει μόνο μηνύματα εντοπισμού σφαλμάτων συμβάντων για επικοινωνίες API Daemon-to-Agent.

Σχετικές εντολές

Εντολή / Περιγραφή

• εντοπισμός σφαλμάτων HTTP; Χρησιμοποιήστε αυτήν την εντολή για να view λεπτομερείς πληροφορίες σχετικά με την κίνηση HTTP.

Μηνύματα Syslog που σχετίζονται με το ASA REST API

Τα μηνύματα καταγραφής συστήματος που σχετίζονται με το ASA REST API περιγράφονται σε αυτήν την ενότητα.

342001

• Μήνυμα σφάλματος: %ASA-7-342001: REST API Agent ξεκίνησε με επιτυχία.
  • Εξήγηση: Ο Πράκτορας REST API πρέπει να ξεκινήσει με επιτυχία προτού ένας πελάτης REST API μπορεί να διαμορφώσει το ASA.
  • Συνιστώμενη δράση: Κανένας.

342002

• Μήνυμα σφάλματος: %ASA-3-342002: REST API Agent απέτυχε, λόγος: λόγος
  • Εξήγηση: Ο παράγοντας REST API ενδέχεται να αποτύχει να ξεκινήσει ή να διακοπεί για διάφορους λόγους και ο λόγος προσδιορίζεται.
  • λόγος—Η αιτία για την αποτυχία REST API

Συνιστώμενη δράση: Οι ενέργειες που γίνονται για την επίλυση του ζητήματος ποικίλλουν ανάλογα με τον λόγο που καταγράφηκε. Για π.χample, ο παράγοντας REST API διακόπτεται όταν εξαντληθεί η μνήμη της διαδικασίας Java. Εάν συμβεί αυτό, πρέπει να επανεκκινήσετε το REST API Agent. Εάν η επανεκκίνηση δεν είναι επιτυχής, επικοινωνήστε με το Cisco TAC για να προσδιορίσετε τη διόρθωση της βασικής αιτίας.

342003

• Μήνυμα σφάλματος: %ASA-3-342003: Λήφθηκε ειδοποίηση αποτυχίας παράγοντα REST API. Ο πράκτορας θα επανεκκινηθεί αυτόματα.
  • Εξήγηση: Έχει ληφθεί μια ειδοποίηση αποτυχίας από τον παράγοντα REST API και επιχειρείται επανεκκίνηση του Agent.
  • Συνιστώμενη δράση: Κανένας.

342004

• Μήνυμα σφάλματος: %ASA-3-342004: Απέτυχε η αυτόματη επανεκκίνηση του REST API Agent μετά από 5 ανεπιτυχείς προσπάθειες. Χρησιμοποιήστε τις εντολές "no rest-api agent" και "rest-api agent" για μη αυτόματη επανεκκίνηση του Agent.
  • Εξήγηση: Ο παράγοντας REST API απέτυχε να ξεκινήσει μετά από πολλές προσπάθειες.
  • Συνιστώμενη δράση: Ανατρέξτε στο σύστημα καταγραφής %ASA-3-342002 (αν είναι συνδεδεμένο) για να κατανοήσετε καλύτερα την αιτία της αποτυχίας. Προσπαθήστε να απενεργοποιήσετε το REST API Agent εισάγοντας την εντολή no rest-api agent και ενεργοποιήστε ξανά τον REST API Agent χρησιμοποιώντας την εντολή rest-api agent.

Σχετική Τεκμηρίωση

Χρησιμοποιήστε τον ακόλουθο σύνδεσμο για να βρείτε περισσότερες πληροφορίες σχετικά με το ASA, τη διαμόρφωση και τη διαχείρισή του:

• Πλοήγηση στην τεκμηρίωση της σειράς Cisco 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 μια λίστα με τα εμπορικά σήματα της Cisco, μεταβείτε σε αυτό URL: www.cisco.com/go/trademarks. Τα αναφερόμενα εμπορικά σήματα τρίτων είναι ιδιοκτησία των αντίστοιχων κατόχων τους. Η χρήση της λέξης συνεργάτης δεν υποδηλώνει σχέση συνεργασίας μεταξύ της Cisco και οποιασδήποτε άλλης εταιρείας. (1721R)
Τυχόν διευθύνσεις πρωτοκόλλου Internet (IP) και αριθμοί τηλεφώνου που χρησιμοποιούνται σε αυτό το έγγραφο δεν προορίζονται να είναι πραγματικές διευθύνσεις και αριθμοί τηλεφώνου. Οποιοσδήποτε πρώηνamples, έξοδος εμφάνισης εντολών, διαγράμματα τοπολογίας δικτύου και άλλα σχήματα που περιλαμβάνονται στο έγγραφο εμφανίζονται μόνο για επεξηγηματικούς σκοπούς.
Οποιαδήποτε χρήση πραγματικών διευθύνσεων IP ή αριθμών τηλεφώνου σε ενδεικτικό περιεχόμενο είναι ακούσια και συμπτωματική.

Cisco Systems, Inc.

• www.cisco.com

© 2014-2018 Cisco Systems, Inc. Με την επιφύλαξη παντός δικαιώματος.

Έγγραφα / Πόροι

Εφαρμογή CISCO ASA REST API [pdf] Οδηγός χρήστη ASA REST API App, ASA, REST API App, API App, App

Αναφορές

• Εγχειρίδιο χρήστη