mirror of
https://github.com/thegeeklab/corenetworks.git
synced 2024-11-13 00:10:42 +00:00
add usage documentation
This commit is contained in:
parent
bf0b307940
commit
f6c358ca15
@ -330,7 +330,7 @@ class CoreNetworks():
|
||||
if isinstance(result, list):
|
||||
return [el for el in result]
|
||||
elif isinstance(result, dict):
|
||||
return result
|
||||
return [result]
|
||||
else:
|
||||
raise CorenetworksError("Unknown type: {}".format(type(result)))
|
||||
|
||||
|
@ -3,3 +3,63 @@ title: Setup
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
```python
|
||||
pip install corenetworks
|
||||
```
|
||||
|
||||
## Example usage
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python
|
||||
|
||||
import requests
|
||||
|
||||
from corenetworks import CoreNetworks
|
||||
from corenetworks.exceptions import CoreNetworksException
|
||||
|
||||
try:
|
||||
user = "my_user"
|
||||
password = "my_password"
|
||||
dns = CoreNetworks(user, password, auto_commit=True)
|
||||
|
||||
zones = dns.zones()
|
||||
print(zones)
|
||||
# [{'name': 'example.com', 'type': 'master'}, {'name': 'test.com', 'type': 'master'}]
|
||||
|
||||
zone = dns.zone(zone="example.com")
|
||||
print(zone)
|
||||
# [{'active': True, 'dnssec': True, 'master': None, 'name': 'example.com', 'tsig': None, 'type': 'master'}]
|
||||
|
||||
records = dns.records(zone="example.com")
|
||||
print(records)
|
||||
# [{'name': '@', 'ttl': '1800', 'type': 'SOA', 'data': 'ns1.core-networks.de. [...]'}, {'name': 'test', 'ttl': '60', 'type': 'A', 'data': '1.2.3.4'}, {'name': '@', 'ttl': '86400', 'type': 'NS', 'data': 'ns1.core-networks.de.'}, {'name': '@', 'ttl': '86400', 'type': 'NS', 'data': 'ns2.core-networks.eu.'}, {'name': '@', 'ttl': '86400', 'type': 'NS', 'data': 'ns3.core-networks.com.'}]
|
||||
|
||||
filtered = dns.records(zone="example.com", params={"type": ["A", "AAAA"]})
|
||||
print(filtered)
|
||||
# [{'name': 'test', 'ttl': '3600', 'type': 'A', 'data': '1.2.3.4'}]
|
||||
|
||||
add_record = dns.add_record(
|
||||
zone="example.com", params={
|
||||
"name": "test",
|
||||
"type": "A",
|
||||
"data": "127.0.0.1",
|
||||
"ttl": 3600,
|
||||
}
|
||||
)
|
||||
print(add_record)
|
||||
# [{'name': 'test', 'ttl': '3600', 'type': 'A', 'data': '127.0.0.1'}]
|
||||
|
||||
del_record = dns.delete_record(zone="example.com", params={
|
||||
"name": "test",
|
||||
"type": "A",
|
||||
})
|
||||
print(del_record)
|
||||
# []
|
||||
|
||||
except Exception as e:
|
||||
print(str(e))
|
||||
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user