Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 185 additions & 0 deletions src/dtc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
# dtc
The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution.

The `dtc` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 0.1.0
- Generator version: 7.5.0
- Build package: com.infoblox.codegen.UniversalDdiPythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

* urllib3 >= 1.25.3
* python-dateutil
* pydantic

## Getting Started

In your own code, to use this library to connect and interact with dtc,
you can run the following:

```python

import dtc
from dtc.rest import ApiException
from pprint import pprint

# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com"
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
portal_url = os.getenv('INFOBLOX_PORTAL_URL'),
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.

# Configure Portal key authorization: ApiKeyAuth
configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY")


# Enter a context with an instance of the API client
with dtc.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dtc.HealthCheckHttpApi(api_client)
body = dtc.HTTPHealthCheck() # HTTPHealthCheck |

try:
# Create the HTTPHealthCheck object.
api_response = api_instance.create(body)
print("The response of HealthCheckHttpApi->create:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling HealthCheckHttpApi->create: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost/api/ddi/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*HealthCheckHttpApi* | [**create**](dtc/docs/HealthCheckHttpApi.md#create) | **POST** /dtc/health_check_http | Create the HTTPHealthCheck object.
*HealthCheckHttpApi* | [**delete**](dtc/docs/HealthCheckHttpApi.md#delete) | **DELETE** /dtc/health_check_http/{id} | Delete the HTTPHealthCheck object.
*HealthCheckHttpApi* | [**list**](dtc/docs/HealthCheckHttpApi.md#list) | **GET** /dtc/health_check_http | Retrieve HTTPHealthCheck objects.
*HealthCheckHttpApi* | [**read**](dtc/docs/HealthCheckHttpApi.md#read) | **GET** /dtc/health_check_http/{id} | Retrieve the HTTPHealthCheck object.
*HealthCheckHttpApi* | [**update**](dtc/docs/HealthCheckHttpApi.md#update) | **PATCH** /dtc/health_check_http/{id} | Update the HTTPHealthCheck object.
*HealthCheckIcmpApi* | [**create**](dtc/docs/HealthCheckIcmpApi.md#create) | **POST** /dtc/health_check_icmp | Create the ICMPHealthCheck object.
*HealthCheckIcmpApi* | [**delete**](dtc/docs/HealthCheckIcmpApi.md#delete) | **DELETE** /dtc/health_check_icmp/{id} | Delete the ICMPHealthCheck object.
*HealthCheckIcmpApi* | [**list**](dtc/docs/HealthCheckIcmpApi.md#list) | **GET** /dtc/health_check_icmp | Retrieve ICMPHealthCheck objects.
*HealthCheckIcmpApi* | [**read**](dtc/docs/HealthCheckIcmpApi.md#read) | **GET** /dtc/health_check_icmp/{id} | Retrieve the ICMPHealthCheck object.
*HealthCheckIcmpApi* | [**update**](dtc/docs/HealthCheckIcmpApi.md#update) | **PATCH** /dtc/health_check_icmp/{id} | Update the ICMPHealthCheck object.
*HealthCheckSnmpApi* | [**create**](dtc/docs/HealthCheckSnmpApi.md#create) | **POST** /dtc/health_check_snmp | Create the SNMPHealthCheck object.
*HealthCheckSnmpApi* | [**delete**](dtc/docs/HealthCheckSnmpApi.md#delete) | **DELETE** /dtc/health_check_snmp/{id} | Delete the SNMPHealthCheck object.
*HealthCheckSnmpApi* | [**list**](dtc/docs/HealthCheckSnmpApi.md#list) | **GET** /dtc/health_check_snmp | Retrieve SNMPHealthCheck objects.
*HealthCheckSnmpApi* | [**read**](dtc/docs/HealthCheckSnmpApi.md#read) | **GET** /dtc/health_check_snmp/{id} | Retrieve the SNMPHealthCheck object.
*HealthCheckSnmpApi* | [**update**](dtc/docs/HealthCheckSnmpApi.md#update) | **PATCH** /dtc/health_check_snmp/{id} | Update the SNMPHealthCheck object.
*HealthCheckTcpApi* | [**create**](dtc/docs/HealthCheckTcpApi.md#create) | **POST** /dtc/health_check_tcp | Create the TCPHealthCheck object.
*HealthCheckTcpApi* | [**delete**](dtc/docs/HealthCheckTcpApi.md#delete) | **DELETE** /dtc/health_check_tcp/{id} | Delete the TCPHealthCheck object.
*HealthCheckTcpApi* | [**list**](dtc/docs/HealthCheckTcpApi.md#list) | **GET** /dtc/health_check_tcp | Retrieve TCPHealthCheck objects.
*HealthCheckTcpApi* | [**read**](dtc/docs/HealthCheckTcpApi.md#read) | **GET** /dtc/health_check_tcp/{id} | Retrieve the TCPHealthCheck object.
*HealthCheckTcpApi* | [**update**](dtc/docs/HealthCheckTcpApi.md#update) | **PATCH** /dtc/health_check_tcp/{id} | Update the TCPHealthCheck object.
*PolicyApi* | [**create**](dtc/docs/PolicyApi.md#create) | **POST** /dtc/policy | Create the Policy object.
*PolicyApi* | [**delete**](dtc/docs/PolicyApi.md#delete) | **DELETE** /dtc/policy/{id} | Delete the Policy object.
*PolicyApi* | [**list**](dtc/docs/PolicyApi.md#list) | **GET** /dtc/policy | Retrieve Policy objects.
*PolicyApi* | [**read**](dtc/docs/PolicyApi.md#read) | **GET** /dtc/policy/{id} | Retrieve the Policy object.
*PolicyApi* | [**update**](dtc/docs/PolicyApi.md#update) | **PATCH** /dtc/policy/{id} | Update the Policy object.
*PoolApi* | [**create**](dtc/docs/PoolApi.md#create) | **POST** /dtc/pool | Create the Pool object.
*PoolApi* | [**delete**](dtc/docs/PoolApi.md#delete) | **DELETE** /dtc/pool/{id} | Delete the Pool object.
*PoolApi* | [**list**](dtc/docs/PoolApi.md#list) | **GET** /dtc/pool | Retrieve Pool objects.
*PoolApi* | [**read**](dtc/docs/PoolApi.md#read) | **GET** /dtc/pool/{id} | Retrieve the Pool object.
*PoolApi* | [**update**](dtc/docs/PoolApi.md#update) | **PATCH** /dtc/pool/{id} | Update the Pool object.
*ServerApi* | [**create**](dtc/docs/ServerApi.md#create) | **POST** /dtc/server | Create the Server object.
*ServerApi* | [**delete**](dtc/docs/ServerApi.md#delete) | **DELETE** /dtc/server/{id} | Delete Server object.
*ServerApi* | [**list**](dtc/docs/ServerApi.md#list) | **GET** /dtc/server | Retrieve Server objects.
*ServerApi* | [**read**](dtc/docs/ServerApi.md#read) | **GET** /dtc/server/{id} | Retrieve the Server object.
*ServerApi* | [**update**](dtc/docs/ServerApi.md#update) | **PATCH** /dtc/server/{id} | Update the Server object.
*SnmpUserSecurityApi* | [**create**](dtc/docs/SnmpUserSecurityApi.md#create) | **POST** /dtc/snmp_user_security_model | Create the SNMPUserSecurityModel object. Use this method to create a __SNMPUserSecurityModel__ object.
*SnmpUserSecurityApi* | [**delete**](dtc/docs/SnmpUserSecurityApi.md#delete) | **DELETE** /dtc/snmp_user_security_model/{id} | Delete the SNMPUserSecurityModel object. Use this method to delete a __SNMPUserSecurityModel__ object.
*SnmpUserSecurityApi* | [**list**](dtc/docs/SnmpUserSecurityApi.md#list) | **GET** /dtc/snmp_user_security_model | Retrieve SNMPUserSecurityModel objects. Use this method to retrieve __SNMPUserSecurityModel__ objects.
*SnmpUserSecurityApi* | [**read**](dtc/docs/SnmpUserSecurityApi.md#read) | **GET** /dtc/snmp_user_security_model/{id} | Retrieve the SNMPUserSecurityModel object. Use this method to retrieve a __SNMPUserSecurityModel__ object.
*SnmpUserSecurityApi* | [**update**](dtc/docs/SnmpUserSecurityApi.md#update) | **PATCH** /dtc/snmp_user_security_model/{id} | Update the SNMPUserSecurityModel object. Use this method to update a __SNMPUserSecurityModel__ object.


## Documentation For Models

- [CreateHTTPHealthCheckResponse](dtc/docs/CreateHTTPHealthCheckResponse.md)
- [CreateICMPHealthCheckResponse](dtc/docs/CreateICMPHealthCheckResponse.md)
- [CreatePolicyResponse](dtc/docs/CreatePolicyResponse.md)
- [CreatePoolResponse](dtc/docs/CreatePoolResponse.md)
- [CreateSNMPHealthCheckResponse](dtc/docs/CreateSNMPHealthCheckResponse.md)
- [CreateSNMPUserSecurityResponse](dtc/docs/CreateSNMPUserSecurityResponse.md)
- [CreateServerResponse](dtc/docs/CreateServerResponse.md)
- [CreateTCPHealthCheckResponse](dtc/docs/CreateTCPHealthCheckResponse.md)
- [HTTPHealthCheck](dtc/docs/HTTPHealthCheck.md)
- [HeaderRegex](dtc/docs/HeaderRegex.md)
- [ICMPHealthCheck](dtc/docs/ICMPHealthCheck.md)
- [Inheritance2InheritedUInt32](dtc/docs/Inheritance2InheritedUInt32.md)
- [ListHTTPHealthCheckResponse](dtc/docs/ListHTTPHealthCheckResponse.md)
- [ListICMPHealthCheckResponse](dtc/docs/ListICMPHealthCheckResponse.md)
- [ListPolicyResponse](dtc/docs/ListPolicyResponse.md)
- [ListPoolResponse](dtc/docs/ListPoolResponse.md)
- [ListSNMPHealthCheckResponse](dtc/docs/ListSNMPHealthCheckResponse.md)
- [ListSNMPUserSecurityResponse](dtc/docs/ListSNMPUserSecurityResponse.md)
- [ListServerResponse](dtc/docs/ListServerResponse.md)
- [ListTCPHealthCheckResponse](dtc/docs/ListTCPHealthCheckResponse.md)
- [Metadata](dtc/docs/Metadata.md)
- [MetadataResourceMeta](dtc/docs/MetadataResourceMeta.md)
- [Policy](dtc/docs/Policy.md)
- [PolicyPool](dtc/docs/PolicyPool.md)
- [Pool](dtc/docs/Pool.md)
- [PoolHealthCheck](dtc/docs/PoolHealthCheck.md)
- [PoolServer](dtc/docs/PoolServer.md)
- [ReadHTTPHealthCheckResponse](dtc/docs/ReadHTTPHealthCheckResponse.md)
- [ReadICMPHealthCheckResponse](dtc/docs/ReadICMPHealthCheckResponse.md)
- [ReadPolicyResponse](dtc/docs/ReadPolicyResponse.md)
- [ReadPoolResponse](dtc/docs/ReadPoolResponse.md)
- [ReadSNMPHealthCheckResponse](dtc/docs/ReadSNMPHealthCheckResponse.md)
- [ReadSNMPUserSecurityResponse](dtc/docs/ReadSNMPUserSecurityResponse.md)
- [ReadServerResponse](dtc/docs/ReadServerResponse.md)
- [ReadTCPHealthCheckResponse](dtc/docs/ReadTCPHealthCheckResponse.md)
- [Record](dtc/docs/Record.md)
- [SNMPHealthCheck](dtc/docs/SNMPHealthCheck.md)
- [SNMPHealthCheckEntryCheck](dtc/docs/SNMPHealthCheckEntryCheck.md)
- [SNMPUserSecurityModel](dtc/docs/SNMPUserSecurityModel.md)
- [Server](dtc/docs/Server.md)
- [TCPHealthCheck](dtc/docs/TCPHealthCheck.md)
- [TTLInheritance](dtc/docs/TTLInheritance.md)
- [TopologyRule](dtc/docs/TopologyRule.md)
- [UpdateHTTPHealthCheckResponse](dtc/docs/UpdateHTTPHealthCheckResponse.md)
- [UpdateICMPHealthCheckResponse](dtc/docs/UpdateICMPHealthCheckResponse.md)
- [UpdatePolicyResponse](dtc/docs/UpdatePolicyResponse.md)
- [UpdatePoolResponse](dtc/docs/UpdatePoolResponse.md)
- [UpdateSNMPHealthCheckResponse](dtc/docs/UpdateSNMPHealthCheckResponse.md)
- [UpdateSNMPUserSecurityResponse](dtc/docs/UpdateSNMPUserSecurityResponse.md)
- [UpdateServerResponse](dtc/docs/UpdateServerResponse.md)
- [UpdateTCPHealthCheckResponse](dtc/docs/UpdateTCPHealthCheckResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author




79 changes: 79 additions & 0 deletions src/dtc/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# coding: utf-8

# flake8: noqa

"""
DNS DTC API

The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution.

The version of the OpenAPI document: v1
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
""" # noqa: E501

__version__ = "0.1.0"

# import apis into sdk package
from dtc.api.health_check_http_api import HealthCheckHttpApi
from dtc.api.health_check_icmp_api import HealthCheckIcmpApi
from dtc.api.health_check_snmp_api import HealthCheckSnmpApi
from dtc.api.health_check_tcp_api import HealthCheckTcpApi
from dtc.api.policy_api import PolicyApi
from dtc.api.pool_api import PoolApi
from dtc.api.server_api import ServerApi
from dtc.api.snmp_user_security_api import SnmpUserSecurityApi

# import models into sdk package
from dtc.models.create_http_health_check_response import CreateHTTPHealthCheckResponse
from dtc.models.create_icmp_health_check_response import CreateICMPHealthCheckResponse
from dtc.models.create_policy_response import CreatePolicyResponse
from dtc.models.create_pool_response import CreatePoolResponse
from dtc.models.create_snmp_health_check_response import CreateSNMPHealthCheckResponse
from dtc.models.create_snmp_user_security_response import CreateSNMPUserSecurityResponse
from dtc.models.create_server_response import CreateServerResponse
from dtc.models.create_tcp_health_check_response import CreateTCPHealthCheckResponse
from dtc.models.http_health_check import HTTPHealthCheck
from dtc.models.header_regex import HeaderRegex
from dtc.models.icmp_health_check import ICMPHealthCheck
from dtc.models.inheritance2_inherited_u_int32 import Inheritance2InheritedUInt32
from dtc.models.list_http_health_check_response import ListHTTPHealthCheckResponse
from dtc.models.list_icmp_health_check_response import ListICMPHealthCheckResponse
from dtc.models.list_policy_response import ListPolicyResponse
from dtc.models.list_pool_response import ListPoolResponse
from dtc.models.list_snmp_health_check_response import ListSNMPHealthCheckResponse
from dtc.models.list_snmp_user_security_response import ListSNMPUserSecurityResponse
from dtc.models.list_server_response import ListServerResponse
from dtc.models.list_tcp_health_check_response import ListTCPHealthCheckResponse
from dtc.models.metadata import Metadata
from dtc.models.metadata_resource_meta import MetadataResourceMeta
from dtc.models.policy import Policy
from dtc.models.policy_pool import PolicyPool
from dtc.models.pool import Pool
from dtc.models.pool_health_check import PoolHealthCheck
from dtc.models.pool_server import PoolServer
from dtc.models.read_http_health_check_response import ReadHTTPHealthCheckResponse
from dtc.models.read_icmp_health_check_response import ReadICMPHealthCheckResponse
from dtc.models.read_policy_response import ReadPolicyResponse
from dtc.models.read_pool_response import ReadPoolResponse
from dtc.models.read_snmp_health_check_response import ReadSNMPHealthCheckResponse
from dtc.models.read_snmp_user_security_response import ReadSNMPUserSecurityResponse
from dtc.models.read_server_response import ReadServerResponse
from dtc.models.read_tcp_health_check_response import ReadTCPHealthCheckResponse
from dtc.models.record import Record
from dtc.models.snmp_health_check import SNMPHealthCheck
from dtc.models.snmp_health_check_entry_check import SNMPHealthCheckEntryCheck
from dtc.models.snmp_user_security_model import SNMPUserSecurityModel
from dtc.models.server import Server
from dtc.models.tcp_health_check import TCPHealthCheck
from dtc.models.ttl_inheritance import TTLInheritance
from dtc.models.topology_rule import TopologyRule
from dtc.models.update_http_health_check_response import UpdateHTTPHealthCheckResponse
from dtc.models.update_icmp_health_check_response import UpdateICMPHealthCheckResponse
from dtc.models.update_policy_response import UpdatePolicyResponse
from dtc.models.update_pool_response import UpdatePoolResponse
from dtc.models.update_snmp_health_check_response import UpdateSNMPHealthCheckResponse
from dtc.models.update_snmp_user_security_response import UpdateSNMPUserSecurityResponse
from dtc.models.update_server_response import UpdateServerResponse
from dtc.models.update_tcp_health_check_response import UpdateTCPHealthCheckResponse
11 changes: 11 additions & 0 deletions src/dtc/api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# flake8: noqa

# import apis into api package
from dtc.api.health_check_http_api import HealthCheckHttpApi
from dtc.api.health_check_icmp_api import HealthCheckIcmpApi
from dtc.api.health_check_snmp_api import HealthCheckSnmpApi
from dtc.api.health_check_tcp_api import HealthCheckTcpApi
from dtc.api.policy_api import PolicyApi
from dtc.api.pool_api import PoolApi
from dtc.api.server_api import ServerApi
from dtc.api.snmp_user_security_api import SnmpUserSecurityApi
Loading
Loading