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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
"""
(c) 2017 DigitalOcean
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
from pynetbox.core.endpoint import Endpoint
from pynetbox.core.query import Request
from pynetbox.models import (
circuits,
core,
dcim,
extras,
ipam,
users,
virtualization,
wireless,
)
class App:
"""Represents apps in NetBox.
Calls to attributes are returned as Endpoint objects.
## Returns
Endpoint matching requested attribute.
## Raises
RequestError if requested endpoint doesn't exist.
"""
def __init__(self, api, name):
self.api = api
self.name = name
self._setmodel()
models = {
"circuits": circuits,
"core": core,
"dcim": dcim,
"extras": extras,
"ipam": ipam,
"users": users,
"virtualization": virtualization,
"wireless": wireless,
}
def _setmodel(self):
self.model = App.models[self.name] if self.name in App.models else None
def __getstate__(self):
return {"api": self.api, "name": self.name}
def __setstate__(self, d):
self.__dict__.update(d)
self._setmodel()
def __getattr__(self, name):
return Endpoint(self.api, self, name, model=self.model)
def config(self):
"""Returns config response from app.
## Returns
Raw response from NetBox's config endpoint.
## Raises
RequestError if called for an invalid endpoint.
## Examples
```python
pprint.pprint(nb.users.config())
{
'tables': {
'DeviceTable': {
'columns': [
'name',
'status',
'tenant',
'role',
'site',
'primary_ip',
'tags'
]
}
}
}
```
"""
config = Request(
base="{}/{}/config/".format(
self.api.base_url,
self.name,
),
token=self.api.token,
http_session=self.api.http_session,
).get()
return config
class PluginsApp:
"""Basically valid plugins api could be handled by same App class,
but you need to add plugins to request url path.
## Returns
App with added plugins into path.
"""
def __init__(self, api):
self.api = api
def __getstate__(self):
return self.__dict__
def __setstate__(self, d):
self.__dict__.update(d)
def __getattr__(self, name):
return App(self.api, "plugins/{}".format(name.replace("_", "-")))
def installed_plugins(self):
"""Returns raw response with installed plugins.
## Returns
Raw response NetBox's installed plugins.
## Examples
```python
nb.plugins.installed_plugins()
[
{
'name': 'test_plugin',
'package': 'test_plugin',
'author': 'Dmitry',
'description': 'Netbox test plugin',
'verison': '0.10'
}
]
```
"""
installed_plugins = Request(
base="{}/plugins/installed-plugins".format(
self.api.base_url,
),
token=self.api.token,
http_session=self.api.http_session,
).get()
return installed_plugins
|
