APIC
wingpy.cisco.apic.CiscoAPIC
¶
CiscoAPIC(
*,
base_url: str | None = None,
username: str | None = None,
password: str | None = None,
verify: SSLContext | bool = True,
timeout: int = 10,
retries: int = 3
)
Bases: RestApiBaseClass
Interact with the Cisco Application Policy Infrastructure Controller (APIC) API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_url
|
str | None
|
Base URL of the API including Overrides the environment variable |
None
|
username
|
str | None
|
Username for API authentication. Overrides the environment variable |
None
|
password
|
str | None
|
Password for API authentication. Overrides the environment variable |
None
|
verify
|
bool | SSLContext
|
Boolean values will enable or disable the default SSL verification. Use an ssl.SSLContext to specify custom Certificate Authority. |
True
|
timeout
|
int
|
Number of seconds to wait for HTTP responses before raising httpx.TimeoutException exception. |
10
|
retries
|
int
|
Number of failed HTTP attempts allowed before raising httpx.HTTPStatusError exception. |
3
|
Examples:
from wingpy import CiscoAPIC
apic = CiscoAPIC(
base_url="https://apic.example.com",
username="admin",
password="password",
verify=False,
)
apic.get_all("/api/class/fvTenant.json")
Source code in src/wingpy/cisco/apic.py
get
¶
get(
path: str,
*,
params: dict | None = None,
path_params: dict | None = None,
headers: dict | None = None,
timeout: int | None = None
) -> httpx.Response
Send an HTTP GET
request to the specified path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The API endpoint path to send the request to. |
required |
params
|
dict | None
|
URL query parameters to include in the request. will be added as |
None
|
path_params
|
dict | None
|
Replace placeholders like Will be combined with self.path_params before sending request. |
None
|
headers
|
dict | None
|
HTTP headers to be sent with the request. Will be combined with self.headers before sending request. |
None
|
timeout
|
int | None
|
Override the standard timeout timer self.timeout for a single request. |
None
|
Returns:
Type | Description |
---|---|
Response
|
The |
Source code in src/wingpy/cisco/apic.py
get_all
¶
get_all(
path: str,
*,
params: dict | None = None,
path_params: dict | None = None,
headers: dict | None = None,
timeout: int | None = None,
page_size: int = 2000
) -> list[dict] | etree._Element
Retrieves all pages of data from an API endpoint path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The API endpoint path to send the request to. |
required |
params
|
dict | None
|
URL query parameters to include in the request. will be added as |
None
|
path_params
|
dict | None
|
Replace placeholders like Will be combined with self.path_params before sending request. |
None
|
headers
|
dict | None
|
HTTP headers to be sent with the request. Will be combined with self.headers before sending request. |
None
|
timeout
|
int | None
|
Override the standard timeout timer self.timeout for a single request. |
None
|
page_size
|
int | None
|
The number of items to retrieve per page. |
2000
|
Returns:
Type | Description |
---|---|
list[dict]
|
A concatenated list of dictionaries represented in the JSON responses. |
_Element
|
A merged |
Source code in src/wingpy/cisco/apic.py
post
¶
post(
path: str,
*,
data: str | dict | list | _Element | None,
path_params: dict | None = None,
headers: dict | None = None,
timeout: int | None = None
) -> httpx.Response
Send an HTTP POST
request to the specified path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The API endpoint path to send the request to. |
required |
data
|
str | dict | list | _Element | None
|
Request payload as JSON string, Python list/dict object or XML Element. |
required |
path_params
|
dict | None
|
Replace placeholders like Will be combined with self.path_params before sending request. |
None
|
headers
|
dict | None
|
HTTP headers to be sent with the request. Will be combined with self.headers before sending request. |
None
|
timeout
|
int | None
|
Override the standard timeout timer self.timeout for a single request. |
None
|
Returns:
Type | Description |
---|---|
Response
|
The |
Source code in src/wingpy/cisco/apic.py
delete
¶
delete(
path: str,
*,
data: str | dict | list | _Element | None = None,
path_params: dict | None = None,
headers: dict | None = None,
timeout: int | None = None
) -> httpx.Response
Send an HTTP DELETE
request to the specified path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The API endpoint path to send the request to. |
required |
data
|
str | dict | list | _Element | None
|
Request payload as JSON string, Python list/dict object or XML Element. |
None
|
path_params
|
dict | None
|
Replace placeholders like Will be combined with self.path_params before sending request. |
None
|
headers
|
dict | None
|
HTTP headers to be sent with the request. Will be combined with self.headers before sending request. |
None
|
timeout
|
int | None
|
Override the standard timeout timer self.timeout for a single request. |
None
|
Returns:
Type | Description |
---|---|
Response
|
The |
Source code in src/wingpy/cisco/apic.py
get_all_json
¶
get_all_json(
path: str,
*,
params: dict | None = None,
path_params: dict | None = None,
headers: dict | None = None,
timeout: int | None = None,
page_size: int = 2000
) -> list[dict]
Retrieves all pages of data from a JSON API endpoint path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The API endpoint path to send the request to. |
required |
params
|
dict | None
|
URL query parameters to include in the request. will be added as |
None
|
path_params
|
dict | None
|
Replace placeholders like Will be combined with self.path_params before sending request. |
None
|
headers
|
dict | None
|
HTTP headers to be sent with the request. Will be combined with self.headers before sending request. |
None
|
timeout
|
int | None
|
Override the standard timeout timer self.timeout for a single request. |
None
|
page_size
|
int | None
|
The number of items to retrieve per page. |
2000
|
Returns:
Type | Description |
---|---|
list[dict]
|
A concatenated list of dictionaries represented in the JSON responses. |
Source code in src/wingpy/cisco/apic.py
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 |
|
get_all_xml
¶
get_all_xml(
path: str,
*,
params: dict | None = None,
path_params: dict | None = None,
headers: dict | None = None,
timeout: int | None = None,
page_size: int = 2000
) -> etree._Element
Retrieves all pages of data from an XML API endpoint path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The API endpoint path to send the request to. |
required |
params
|
dict | None
|
URL query parameters to include in the request. will be added as |
None
|
path_params
|
dict | None
|
Replace placeholders like Will be combined with self.path_params before sending request. |
None
|
headers
|
dict | None
|
HTTP headers to be sent with the request. Will be combined with self.headers before sending request. |
None
|
timeout
|
int | None
|
Override the standard timeout timer self.timeout for a single request. |
None
|
page_size
|
int | None
|
The number of items to retrieve per page. |
2000
|
Returns:
Type | Description |
---|---|
_Element
|
A merged |
Source code in src/wingpy/cisco/apic.py
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 |
|
authenticate
¶
Executes the API-specific authentication process and records timestamps for session tracking.
Notes
Authentication will automatically be carried out just-in-time.
Only call this method directly if you need to authenticate proactively, outside of normal request flow.
Source code in src/wingpy/base.py
tasks
instance-attribute
¶
Manages concurrent requests to the API server.
The number of concurrent requests is limited by the MAX_CONNECTIONS property:
- 1 connection is reserved for the main thread used for authentication and synchronous requests.
- The remaining connections are used for concurrent requests.
See Also
wingpy.scheduling.TaskRunner
Schedule and run asynchronous tasks in parallel.
timeout
instance-attribute
¶
The timeout in seconds for each request to the API server.
MAX_CONNECTIONS
class-attribute
instance-attribute
¶
The maximum number of concurrent connections opened to the APIC.
1 connection will be used for general synchronous requests.
19 connections will be used for parallel asynchronous requests.
RETRY_RESPONSES
class-attribute
instance-attribute
¶
RETRY_RESPONSES = [
HttpResponsePattern(
status_codes=[503],
methods=["GET", "POST", "DELETE"],
content_patterns=[
compile(
"<!DOCTYPE html>\\n<html>\\n<head>\\n<title>Error</title>\\n<style>\\n body {\\n width: 35em;\\n margin: 0 auto;\\n font-family: Tahoma, Verdana, Arial, sans-serif;\\n }\\n</style>\\n</head>\\n<body>\\n<h1>An error occurred\\.</h1>\\n<p>Sorry, the page you are looking for is currently unavailable\\.<br/>\\nPlease try again later\\.</p>\\n<p>If you are the system administrator of this resource then you should check\\nthe error log for details\\.</p>\\n<p><em>Faithfully yours, nginx\\.</em></p>\\n</body>\\n</html>\\n"
)
],
)
]
Cisco APIC has not implemented HTTP status code 429 for rate limiting. Instead it returns an NGINX default error page with HTTP status code 503.
headers
instance-attribute
¶
A dictionary of HTTP headers to be sent with each request.
These headers will be merged with any headers
dict passed to an individual request.
path_params
instance-attribute
¶
A dictionary of path parameters to be used in the API path of each request.
These parameters will be merged with any path_params
dict passed to the request.