Skip to content
Snippets Groups Projects
Commit a809b547 authored by Janis Streib's avatar Janis Streib :owl:
Browse files

Update README.md

parent fed1cd41
Branches
No related tags found
No related merge requests found
......@@ -17,14 +17,14 @@ The existing config files can still be used, but the config option will be ignor
### Init
Initialisation works as followed, for configuration an `APIEndpoint`-Instance has to be passed to the `API-Session` call.
```python
>>> import netdb_client
>>> import netdb_client.api31
>>> import netdb_client.util
>>> endpoint = netdb_client.APIEndpoint(
base_url='www-net-devel.scc.kit.edu',
token='<token>'
)
>>> api = netdb_client.APISession(endpoint)
>>> api = netdb_client.api31.APISession(endpoint)
```
`util` provides an `ArgumentParser`-Class which can be used for configuration and config loading. This class has been
......@@ -84,24 +84,24 @@ More examples can be found in the [wiki article](https://git.scc.kit.edu/scc-net
### Basic queries
List all BCDs:
```python
>>> import netdb_client.nd
>>> netdb_client.nd.Bcd.list(api_session=api)
>>> import netdb_client.api31.nd
>>> netdb_client.api31.nd.Bcd.list(api_session=api)
[Bcd(name='scc-net-web-1', categ='USER', is_own=True, log_pk=13270200, seclvl=0, vlan_count=1, description='[scc-net-web/1]: Webserver von SCC-NET / [ipv6-scc-net-web/1]: Webserver von SCC-NET *** ehemalige Bereichsinfo ***: [scc-net-web/1]: Webserver von SCC-NET / [ipv6-scc-net-web/1]: Webserver von SCC-NET', dhcp_enabled=False, subnet_count=2, ou_short_name='SCC-NET', dhcp_ttl_value=600, admin_description=None, dhcp_accept_new_leases=False, dhcp_leasetime_dyn_days=0, dhcp_leasetime_dyn_hours=2, dhcp_leasetime_dyn_minutes=0, dhcp_leasetime_static_days=0, dhcp_leasetime_static_hours=6, dhcp_offer_rsv_time_minutes=0, dhcp_offer_rsv_time_seconds=30, dhcp_leasetime_static_minutes=0, dhcp_accept_requested_hostname=True)]
```
List all CNAME-Records for given BCD:
```python
>>> import netdb_client.dns
>>> netdb_client.dns.Record.list(api_session=api, type_old="CNAME", bcd_list_old=["scc-net-web-1"])
>>> import netdb_client.api31.dns
>>> netdb_client.api31.dns.Record.list(api_session=api, type_old="CNAME", bcd_list_old=["scc-net-web-1"])
[..., Record(ttl=None, data='net-web09.scc.kit.edu.', fqdn='netvs-devel.scc.kit.edu.', type='CNAME', zone='kit.edu.', is_own=True, fqdn_type='alias', host_is_nws=False, target_fqdn='net-web09.scc.kit.edu.', target_ipaddr=None, ttl_reset_date=None, fqdn_description=None, target_fqdn_type='host', ttl_zone_default=3600, target_data_unref=None, target_is_singleton=True, target_is_reverse_unique=False), ...]
```
### Advanced queries
List BCDs with their Subnets:
```python
>>> netdb_client.nd
>>> import netdb_client.api31.nd
>>> api.execute_ta([
netdb_client.nd.Bcd.list_ta(), # == {"name": "nd.bcd.list"}
netdb_client.nd.api31.Bcd.list_ta(), # == {"name": "nd.bcd.list"}
{"name": "nd.ip_subnet.list", "join": {0: "default"}},
])
[[{'name': 'scc-net-web-1', ...}], [{'bcd': 'scc-net-web-1', ...}, ...]]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment