File: public_api_status.md

package info (click to toggle)
python-scrapli 2023.7.30-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,508 kB
  • sloc: python: 14,451; makefile: 72
file content (146 lines) | stat: -rw-r--r-- 11,486 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# Public API Status

Note that all public methods, unless otherwise noted, are available in sync and async form depending on the driver
 you have selected.


## Drivers

### Driver

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| open                          | 2020.03.29  |             |                                                              |
| close                         | 2020.03.29  |             |                                                              |
| isalive                       | 2020.03.29  |             |                                                              |


### AsyncDriver

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| open                          | 2020.06.06  |             |                                                              |
| close                         | 2020.06.06  |             |                                                              |
| isalive                       | 2020.06.06  |             |                                                              |


### GenericDriver (and NetworkDriver sub-classes unless overridden)

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| get_prompt                    | 2020.03.29  |             |                                                              |
| send_command                  | 2020.03.29  | 2020.08.09  | added `timeout_ops` keyword argument to modify timeout       |
| send_commands                 | 2020.03.29  | 2020.12.31  | added `eager` keyword argument                               |
| send_commands_from_file       | 2020.04.30  | 2020.12.31  | added `eager` keyword argument                               |
| send_interactive              | 2020.03.29  | 2021.01.30  | added `interaction_complete_patterns` keyword argument       |
| send_and_read                 | 2020.08.28  |             |                                                              |
| send_callback                 | 2022.01.30  |             |                                                              |


### AsyncGenericDriver (and NetworkDriver sub-classes unless overridden)

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| get_prompt                    | 2020.06.06  |             |                                                              |
| send_command                  | 2020.06.06  | 2020.08.09  | added `timeout_ops` keyword argument to modify timeout       |
| send_commands                 | 2020.06.06  | 2020.12.31  | added `eager` keyword argument                               |
| send_commands_from_file       | 2020.06.06  | 2020.12.31  | added `eager` keyword argument                               |
| send_interactive              | 2020.06.06  | 2021.01.30  | added `interaction_complete_patterns` keyword argument       |
| send_and_read                 | 2020.08.28  |             |                                                              |
| send_callback                 | 2022.01.30  |             |                                                              |


### NetworkDriver (and Platform driver sub-classes unless overridden)

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| update_privilege_levels       | 2020.05.09  |             | update priv map/all prompt pattern if adding/modifying privs |
| acquire_priv                  | 2020.03.29  |             |                                                              |
| register_configuration_session| 2020.05.09  |             | register a config session so the priv level can be tracked   |
| send_config                   | 2020.05.09  | 2020.12.31  | added `eager` keyword argument                               |
| send_configs                  | 2020.03.29  | 2020.12.31  | added `eager` keyword argument                               |
| send_configs_from_file        | 2020.04.30  | 2020.12.31  | added `eager` keyword argument                               |
| send_interactive              | 2020.03.29  | 2021.01.30  | added `interaction_complete_patterns` keyword argument       |


### AsyncNetworkDriver (and Platform driver sub-classes unless overridden)

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| update_privilege_levels       | 2020.06.06  |             |                                                              |
| acquire_priv                  | 2020.06.06  |             |                                                              |
| register_configuration_session| 2020.06.06  |             |                                                              |
| send_config                   | 2020.06.06  | 2020.12.31  | added `eager` keyword argument                               |
| send_configs                  | 2020.06.06  | 2020.12.31  | added `eager` keyword argument                               |
| send_configs_from_file        | 2020.06.06  | 2020.12.31  | added `eager` keyword argument                               |
| send_interactive              | 2020.06.06  | 2021.01.30  | added `interaction_complete_patterns` keyword argument       |


## Channel

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| get_prompt                    | 2020.03.29  |             |                                                              |
| send_input                    | 2020.03.29  | 2020.12.31  | added `eager` keyword argument                               |
| send_inputs_interact          | 2020.03.29  | 2020.04.11  | changed to support list of "events" to interact with         |
| send_input_and_read           | 2020.08.28  |             |                                                              |


## AsyncChannel

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| get_prompt                    | 2020.06.06  |             |                                                              |
| send_input                    | 2020.06.06  | 2020.12.31  | added `eager` keyword argument                               |
| send_inputs_interact          | 2020.06.06  |             |                                                              |
| send_input_and_read           | 2020.08.28  |             |                                                              |


## Transport

### Transport ABC (and Transport sub-classes unless overridden)

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| open                          | 2020.03.29  |             |                                                              |
| close                         | 2020.03.29  |             |                                                              |
| isalive                       | 2020.03.29  |             |                                                              |
| read                          | 2020.03.29  |             |                                                              |
| write                         | 2020.03.29  |             |                                                              |
| set_timeout                   | 2020.03.29  |             |                                                              |


### AsyncTransport ABC (and Transport sub-classes unless overridden)

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| open                          | 2020.06.06  |             |                                                              |
| close                         | 2020.06.06  |             |                                                              |
| isalive                       | 2020.06.06  |             |                                                              |
| read                          | 2020.06.06  |             |                                                              |
| write                         | 2020.06.06  |             |                                                              |
| set_timeout                   | 2020.06.06  |             |                                                              |


## Response

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| genie_parse_output            | 2020.03.29  |             |                                                              |
| textfsm_parse_output          | 2020.03.29  |             |                                                              |
| ttp_parse_output              | 2020.10.10  |             | Unlike other parse methods, requires a template argument     |
| raise_for_status              | 2020.05.09  |             |                                                              |


## MultiResponse

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| raise_for_status              | 2020.05.09  |             |                                                              |


## SSHConfig

| Method                        | Implemented | Last Change | Notes                                                        |
|-------------------------------|-------------|-------------|--------------------------------------------------------------|
| lookup                        | 2020.03.29  |             |                                                              |