Autogenerated using update_openapi_client
from udm-rest-client
Actual generator command: ```bash java -jar openapi-generator-cli-5.4.0.jar generate -g python-legacy \ --library asyncio \ --package-name openapi_client_udm \ --additional-properties=packageVersion=1.0.2 \ -i udm_openapi.json \ -o ./python ```
This commit is contained in:
commit
98daa460a6
66
.gitignore
vendored
Normal file
66
.gitignore
vendored
Normal file
@ -0,0 +1,66 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
venv/
|
||||
.venv/
|
||||
.python-version
|
||||
.pytest_cache
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
#Ipython Notebook
|
||||
.ipynb_checkpoints
|
33
.gitlab-ci.yml
Normal file
33
.gitlab-ci.yml
Normal file
@ -0,0 +1,33 @@
|
||||
# ref: https://docs.gitlab.com/ee/ci/README.html
|
||||
|
||||
stages:
|
||||
- test
|
||||
|
||||
.nosetest:
|
||||
stage: test
|
||||
script:
|
||||
- pip install -r requirements.txt
|
||||
- pip install -r test-requirements.txt
|
||||
- pytest --cov=openapi_client_udm
|
||||
|
||||
nosetest-2.7:
|
||||
extends: .nosetest
|
||||
image: python:2.7-alpine
|
||||
nosetest-3.3:
|
||||
extends: .nosetest
|
||||
image: python:3.3-alpine
|
||||
nosetest-3.4:
|
||||
extends: .nosetest
|
||||
image: python:3.4-alpine
|
||||
nosetest-3.5:
|
||||
extends: .nosetest
|
||||
image: python:3.5-alpine
|
||||
nosetest-3.6:
|
||||
extends: .nosetest
|
||||
image: python:3.6-alpine
|
||||
nosetest-3.7:
|
||||
extends: .nosetest
|
||||
image: python:3.7-alpine
|
||||
nosetest-3.8:
|
||||
extends: .nosetest
|
||||
image: python:3.8-alpine
|
23
.openapi-generator-ignore
Normal file
23
.openapi-generator-ignore
Normal file
@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
3004
.openapi-generator/FILES
Normal file
3004
.openapi-generator/FILES
Normal file
File diff suppressed because it is too large
Load Diff
1
.openapi-generator/VERSION
Normal file
1
.openapi-generator/VERSION
Normal file
@ -0,0 +1 @@
|
||||
5.4.0
|
17
.travis.yml
Normal file
17
.travis.yml
Normal file
@ -0,0 +1,17 @@
|
||||
# ref: https://docs.travis-ci.com/user/languages/python
|
||||
language: python
|
||||
python:
|
||||
- "2.7"
|
||||
- "3.2"
|
||||
- "3.3"
|
||||
- "3.4"
|
||||
- "3.5"
|
||||
- "3.6"
|
||||
- "3.7"
|
||||
- "3.8"
|
||||
# command to install dependencies
|
||||
install:
|
||||
- "pip install -r requirements.txt"
|
||||
- "pip install -r test-requirements.txt"
|
||||
# command to run tests
|
||||
script: pytest --cov=openapi_client_udm
|
20
docs/AppcenterApp.md
Normal file
20
docs/AppcenterApp.md
Normal file
@ -0,0 +1,20 @@
|
||||
# AppcenterApp
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | **dict(str, object)** | Object type specific `UDM` options. | [optional]
|
||||
**policies** | [**AppcenterAppPolicies**](AppcenterAppPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/AppcenterAppApi.md
Normal file
686
docs/AppcenterAppApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.AppcenterAppApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_appcenter_app_object**](AppcenterAppApi.md#udm_appcenter_app_object) | **GET** /appcenter/app/{dn} | Get a representation of the App Metadata object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_appcenter_app_object_create**](AppcenterAppApi.md#udm_appcenter_app_object_create) | **POST** /appcenter/app/ | Create a new App Metadata object
|
||||
[**udm_appcenter_app_object_modify**](AppcenterAppApi.md#udm_appcenter_app_object_modify) | **PUT** /appcenter/app/{dn} | Modify or move an App Metadata object
|
||||
[**udm_appcenter_app_object_remove**](AppcenterAppApi.md#udm_appcenter_app_object_remove) | **DELETE** /appcenter/app/{dn} | Remove a App Metadata object
|
||||
[**udm_appcenter_app_object_search**](AppcenterAppApi.md#udm_appcenter_app_object_search) | **GET** /appcenter/app/ | Search for App Metadata objects
|
||||
[**udm_appcenter_app_object_template**](AppcenterAppApi.md#udm_appcenter_app_object_template) | **GET** /appcenter/app/add | Get a template for creating an App Metadata object (contains all properties and their default values)
|
||||
[**udm_appcenter_app_object_update**](AppcenterAppApi.md#udm_appcenter_app_object_update) | **PATCH** /appcenter/app/{dn} | Modify an App Metadata object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_appcenter_app_object**
|
||||
> AppcenterApp udm_appcenter_app_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the App Metadata object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the App Metadata object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_appcenter_app_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**AppcenterApp**](AppcenterApp.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_appcenter_app_object_create**
|
||||
> InlineResponse201 udm_appcenter_app_object_create(appcenter_app, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new App Metadata object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
appcenter_app = openapi_client_udm.AppcenterApp() # AppcenterApp |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new App Metadata object
|
||||
api_response = api_instance.udm_appcenter_app_object_create(appcenter_app, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**appcenter_app** | [**AppcenterApp**](AppcenterApp.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_appcenter_app_object_modify**
|
||||
> InlineResponse201 udm_appcenter_app_object_modify(dn, appcenter_app, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an App Metadata object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
appcenter_app = openapi_client_udm.AppcenterApp() # AppcenterApp |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an App Metadata object
|
||||
api_response = api_instance.udm_appcenter_app_object_modify(dn, appcenter_app, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**appcenter_app** | [**AppcenterApp**](AppcenterApp.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_appcenter_app_object_remove**
|
||||
> udm_appcenter_app_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a App Metadata object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a App Metadata object
|
||||
api_instance.udm_appcenter_app_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_appcenter_app_object_search**
|
||||
> AppcenterAppList udm_appcenter_app_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for App Metadata objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for App Metadata objects
|
||||
api_response = api_instance.udm_appcenter_app_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**AppcenterAppList**](AppcenterAppList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_appcenter_app_object_template**
|
||||
> AppcenterApp udm_appcenter_app_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an App Metadata object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an App Metadata object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_appcenter_app_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**AppcenterApp**](AppcenterApp.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new App Metadata. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_appcenter_app_object_update**
|
||||
> udm_appcenter_app_object_update(dn, appcenter_app, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an App Metadata object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.AppcenterAppApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
appcenter_app = openapi_client_udm.AppcenterApp() # AppcenterApp |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an App Metadata object (moving is currently not possible)
|
||||
api_instance.udm_appcenter_app_object_update(dn, appcenter_app, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppcenterAppApi->udm_appcenter_app_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**appcenter_app** | [**AppcenterApp**](AppcenterApp.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/AppcenterAppList.md
Normal file
11
docs/AppcenterAppList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AppcenterAppList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**AppcenterAppListEmbedded**](AppcenterAppListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/AppcenterAppListEmbedded.md
Normal file
11
docs/AppcenterAppListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AppcenterAppListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[AppcenterApp]**](AppcenterApp.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
35
docs/AppcenterAppPolicies.md
Normal file
35
docs/AppcenterAppPolicies.md
Normal file
@ -0,0 +1,35 @@
|
||||
# AppcenterAppPolicies
|
||||
|
||||
Policies which apply for this object.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**policies_slavepackages** | **list[str]** | Policy: Packages for Replica Nodes | [optional]
|
||||
**policies_dhcp_dns** | **list[str]** | Policy: DHCP DNS | [optional]
|
||||
**policies_printserver** | **list[str]** | Policy: Print server | [optional]
|
||||
**policies_dhcp_scope** | **list[str]** | Policy: DHCP Allow/Deny | [optional]
|
||||
**policies_dhcp_dnsupdate** | **list[str]** | Policy: DHCP Dynamic DNS | [optional]
|
||||
**policies_dhcp_boot** | **list[str]** | Policy: DHCP Boot | [optional]
|
||||
**policies_repositorysync** | **list[str]** | Policy: Repository synchronisation | [optional]
|
||||
**policies_dhcp_statements** | **list[str]** | Policy: DHCP statements | [optional]
|
||||
**policies_nfsmounts** | **list[str]** | Policy: NFS mounts | [optional]
|
||||
**policies_memberpackages** | **list[str]** | Policy: Packages for Managed Nodes | [optional]
|
||||
**policies_umc** | **list[str]** | Policy: UMC | [optional]
|
||||
**policies_maintenance** | **list[str]** | Policy: Maintenance | [optional]
|
||||
**policies_desktop** | **list[str]** | Policy: Desktop | [optional]
|
||||
**policies_dhcp_netbios** | **list[str]** | Policy: DHCP NetBIOS | [optional]
|
||||
**policies_admin_container** | **list[str]** | Policy: Univention Directory Manager container settings | [optional]
|
||||
**policies_dhcp_routing** | **list[str]** | Policy: DHCP routing | [optional]
|
||||
**policies_release** | **list[str]** | Policy: Automatic updates | [optional]
|
||||
**policies_share_userquota** | **list[str]** | Policy: User quota | [optional]
|
||||
**policies_pwhistory** | **list[str]** | Policy: Passwords | [optional]
|
||||
**policies_dhcp_leasetime** | **list[str]** | Policy: DHCP lease time | [optional]
|
||||
**policies_registry** | **list[str]** | Policy: Univention Configuration Registry | [optional]
|
||||
**policies_masterpackages** | **list[str]** | Policy: Packages for Primary/Backup Nodes | [optional]
|
||||
**policies_ldapserver** | **list[str]** | Policy: LDAP server | [optional]
|
||||
**policies_repositoryserver** | **list[str]** | Policy: Repository server | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/AppcenterAppRequest.md
Normal file
15
docs/AppcenterAppRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# AppcenterAppRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | **dict(str, object)** | Object type specific `UDM` options. | [optional]
|
||||
**policies** | [**AppcenterAppPolicies**](AppcenterAppPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/AppcenterAppRequestAllOf.md
Normal file
11
docs/AppcenterAppRequestAllOf.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AppcenterAppRequestAllOf
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/AppcenterAppRequestPatch.md
Normal file
14
docs/AppcenterAppRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# AppcenterAppRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | **dict(str, object)** | Object type specific `UDM` options. | [optional]
|
||||
**policies** | [**AppcenterAppPolicies**](AppcenterAppPolicies.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/AppcenterAppResponseMixin.md
Normal file
15
docs/AppcenterAppResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# AppcenterAppResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersComputer.md
Normal file
20
docs/ComputersComputer.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersComputer
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | **dict(str, object)** | Object type specific `UDM` options. | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
201
docs/ComputersComputerApi.md
Normal file
201
docs/ComputersComputerApi.md
Normal file
@ -0,0 +1,201 @@
|
||||
# openapi_client_udm.ComputersComputerApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_computer_object**](ComputersComputerApi.md#udm_computers_computer_object) | **GET** /computers/computer/{dn} | Get a representation of the Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_computer_object_search**](ComputersComputerApi.md#udm_computers_computer_object_search) | **GET** /computers/computer/ | Search for Computers objects
|
||||
|
||||
|
||||
# **udm_computers_computer_object**
|
||||
> ComputersComputer udm_computers_computer_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersComputerApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_computer_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersComputerApi->udm_computers_computer_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersComputer**](ComputersComputer.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_computer_object_search**
|
||||
> ComputersComputerList udm_computers_computer_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Computers objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersComputerApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Computers objects
|
||||
api_response = api_instance.udm_computers_computer_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersComputerApi->udm_computers_computer_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersComputerList**](ComputersComputerList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersComputerList.md
Normal file
11
docs/ComputersComputerList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersComputerList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersComputerListEmbedded**](ComputersComputerListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersComputerListEmbedded.md
Normal file
11
docs/ComputersComputerListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersComputerListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersComputer]**](ComputersComputer.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersComputerRequest.md
Normal file
15
docs/ComputersComputerRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersComputerRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | **dict(str, object)** | Object type specific `UDM` options. | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersComputerRequestPatch.md
Normal file
14
docs/ComputersComputerRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersComputerRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | **dict(str, object)** | Object type specific `UDM` options. | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersComputerResponseMixin.md
Normal file
15
docs/ComputersComputerResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersComputerResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersDomaincontrollerBackup.md
Normal file
20
docs/ComputersDomaincontrollerBackup.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersDomaincontrollerBackup
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerBackupOptions**](ComputersDomaincontrollerBackupOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerBackupPolicies**](ComputersDomaincontrollerBackupPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersDomaincontrollerBackupApi.md
Normal file
686
docs/ComputersDomaincontrollerBackupApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersDomaincontrollerBackupApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_domaincontroller_backup_object**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object) | **GET** /computers/domaincontroller_backup/{dn} | Get a representation of the Backup Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_domaincontroller_backup_object_create**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object_create) | **POST** /computers/domaincontroller_backup/ | Create a new Backup Directory Node object
|
||||
[**udm_computers_domaincontroller_backup_object_modify**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object_modify) | **PUT** /computers/domaincontroller_backup/{dn} | Modify or move an Backup Directory Node object
|
||||
[**udm_computers_domaincontroller_backup_object_remove**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object_remove) | **DELETE** /computers/domaincontroller_backup/{dn} | Remove a Backup Directory Nodes object
|
||||
[**udm_computers_domaincontroller_backup_object_search**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object_search) | **GET** /computers/domaincontroller_backup/ | Search for Backup Directory Nodes objects
|
||||
[**udm_computers_domaincontroller_backup_object_template**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object_template) | **GET** /computers/domaincontroller_backup/add | Get a template for creating an Backup Directory Node object (contains all properties and their default values)
|
||||
[**udm_computers_domaincontroller_backup_object_update**](ComputersDomaincontrollerBackupApi.md#udm_computers_domaincontroller_backup_object_update) | **PATCH** /computers/domaincontroller_backup/{dn} | Modify an Backup Directory Node object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object**
|
||||
> ComputersDomaincontrollerBackup udm_computers_domaincontroller_backup_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Backup Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Backup Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_domaincontroller_backup_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerBackup**](ComputersDomaincontrollerBackup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object_create**
|
||||
> InlineResponse201 udm_computers_domaincontroller_backup_object_create(computers_domaincontroller_backup, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Backup Directory Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
computers_domaincontroller_backup = openapi_client_udm.ComputersDomaincontrollerBackup() # ComputersDomaincontrollerBackup |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Backup Directory Node object
|
||||
api_response = api_instance.udm_computers_domaincontroller_backup_object_create(computers_domaincontroller_backup, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_domaincontroller_backup** | [**ComputersDomaincontrollerBackup**](ComputersDomaincontrollerBackup.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object_modify**
|
||||
> InlineResponse201 udm_computers_domaincontroller_backup_object_modify(dn, computers_domaincontroller_backup, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Backup Directory Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_domaincontroller_backup = openapi_client_udm.ComputersDomaincontrollerBackup() # ComputersDomaincontrollerBackup |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Backup Directory Node object
|
||||
api_response = api_instance.udm_computers_domaincontroller_backup_object_modify(dn, computers_domaincontroller_backup, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_domaincontroller_backup** | [**ComputersDomaincontrollerBackup**](ComputersDomaincontrollerBackup.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object_remove**
|
||||
> udm_computers_domaincontroller_backup_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Backup Directory Nodes object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Backup Directory Nodes object
|
||||
api_instance.udm_computers_domaincontroller_backup_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object_search**
|
||||
> ComputersDomaincontrollerBackupList udm_computers_domaincontroller_backup_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Backup Directory Nodes objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Backup Directory Nodes objects
|
||||
api_response = api_instance.udm_computers_domaincontroller_backup_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerBackupList**](ComputersDomaincontrollerBackupList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object_template**
|
||||
> ComputersDomaincontrollerBackup udm_computers_domaincontroller_backup_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Backup Directory Node object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Backup Directory Node object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_domaincontroller_backup_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerBackup**](ComputersDomaincontrollerBackup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Backup Directory Node. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_backup_object_update**
|
||||
> udm_computers_domaincontroller_backup_object_update(dn, computers_domaincontroller_backup, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Backup Directory Node object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerBackupApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_domaincontroller_backup = openapi_client_udm.ComputersDomaincontrollerBackup() # ComputersDomaincontrollerBackup |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Backup Directory Node object (moving is currently not possible)
|
||||
api_instance.udm_computers_domaincontroller_backup_object_update(dn, computers_domaincontroller_backup, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerBackupApi->udm_computers_domaincontroller_backup_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_domaincontroller_backup** | [**ComputersDomaincontrollerBackup**](ComputersDomaincontrollerBackup.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersDomaincontrollerBackupList.md
Normal file
11
docs/ComputersDomaincontrollerBackupList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersDomaincontrollerBackupList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersDomaincontrollerBackupListEmbedded**](ComputersDomaincontrollerBackupListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersDomaincontrollerBackupListEmbedded.md
Normal file
11
docs/ComputersDomaincontrollerBackupListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersDomaincontrollerBackupListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersDomaincontrollerBackup]**](ComputersDomaincontrollerBackup.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersDomaincontrollerBackupOptions.md
Normal file
17
docs/ComputersDomaincontrollerBackupOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersDomaincontrollerBackupOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersDomaincontrollerBackupPolicies.md
Normal file
20
docs/ComputersDomaincontrollerBackupPolicies.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersDomaincontrollerBackupPolicies
|
||||
|
||||
Policies which apply for this object.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**policies_printserver** | **list[str]** | Policy: Print server | [optional]
|
||||
**policies_repositorysync** | **list[str]** | Policy: Repository synchronisation | [optional]
|
||||
**policies_nfsmounts** | **list[str]** | Policy: NFS mounts | [optional]
|
||||
**policies_umc** | **list[str]** | Policy: UMC | [optional]
|
||||
**policies_maintenance** | **list[str]** | Policy: Maintenance | [optional]
|
||||
**policies_release** | **list[str]** | Policy: Automatic updates | [optional]
|
||||
**policies_registry** | **list[str]** | Policy: Univention Configuration Registry | [optional]
|
||||
**policies_masterpackages** | **list[str]** | Policy: Packages for Primary/Backup Nodes | [optional]
|
||||
**policies_repositoryserver** | **list[str]** | Policy: Repository server | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersDomaincontrollerBackupRequest.md
Normal file
15
docs/ComputersDomaincontrollerBackupRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersDomaincontrollerBackupRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerBackupOptions**](ComputersDomaincontrollerBackupOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerBackupPolicies**](ComputersDomaincontrollerBackupPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersDomaincontrollerBackupRequestPatch.md
Normal file
14
docs/ComputersDomaincontrollerBackupRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersDomaincontrollerBackupRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerBackupOptions**](ComputersDomaincontrollerBackupOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerBackupPolicies**](ComputersDomaincontrollerBackupPolicies.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersDomaincontrollerBackupResponseMixin.md
Normal file
15
docs/ComputersDomaincontrollerBackupResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersDomaincontrollerBackupResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersDomaincontrollerMaster.md
Normal file
20
docs/ComputersDomaincontrollerMaster.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersDomaincontrollerMaster
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerMasterOptions**](ComputersDomaincontrollerMasterOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerMasterPolicies**](ComputersDomaincontrollerMasterPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersDomaincontrollerMasterApi.md
Normal file
686
docs/ComputersDomaincontrollerMasterApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersDomaincontrollerMasterApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_domaincontroller_master_object**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object) | **GET** /computers/domaincontroller_master/{dn} | Get a representation of the Primary Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_domaincontroller_master_object_create**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object_create) | **POST** /computers/domaincontroller_master/ | Create a new Primary Directory Node object
|
||||
[**udm_computers_domaincontroller_master_object_modify**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object_modify) | **PUT** /computers/domaincontroller_master/{dn} | Modify or move an Primary Directory Node object
|
||||
[**udm_computers_domaincontroller_master_object_remove**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object_remove) | **DELETE** /computers/domaincontroller_master/{dn} | Remove a Primary Directory Nodes object
|
||||
[**udm_computers_domaincontroller_master_object_search**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object_search) | **GET** /computers/domaincontroller_master/ | Search for Primary Directory Nodes objects
|
||||
[**udm_computers_domaincontroller_master_object_template**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object_template) | **GET** /computers/domaincontroller_master/add | Get a template for creating an Primary Directory Node object (contains all properties and their default values)
|
||||
[**udm_computers_domaincontroller_master_object_update**](ComputersDomaincontrollerMasterApi.md#udm_computers_domaincontroller_master_object_update) | **PATCH** /computers/domaincontroller_master/{dn} | Modify an Primary Directory Node object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_domaincontroller_master_object**
|
||||
> ComputersDomaincontrollerMaster udm_computers_domaincontroller_master_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Primary Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Primary Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_domaincontroller_master_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerMaster**](ComputersDomaincontrollerMaster.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_master_object_create**
|
||||
> InlineResponse201 udm_computers_domaincontroller_master_object_create(computers_domaincontroller_master, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Primary Directory Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
computers_domaincontroller_master = openapi_client_udm.ComputersDomaincontrollerMaster() # ComputersDomaincontrollerMaster |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Primary Directory Node object
|
||||
api_response = api_instance.udm_computers_domaincontroller_master_object_create(computers_domaincontroller_master, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_domaincontroller_master** | [**ComputersDomaincontrollerMaster**](ComputersDomaincontrollerMaster.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_master_object_modify**
|
||||
> InlineResponse201 udm_computers_domaincontroller_master_object_modify(dn, computers_domaincontroller_master, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Primary Directory Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_domaincontroller_master = openapi_client_udm.ComputersDomaincontrollerMaster() # ComputersDomaincontrollerMaster |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Primary Directory Node object
|
||||
api_response = api_instance.udm_computers_domaincontroller_master_object_modify(dn, computers_domaincontroller_master, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_domaincontroller_master** | [**ComputersDomaincontrollerMaster**](ComputersDomaincontrollerMaster.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_master_object_remove**
|
||||
> udm_computers_domaincontroller_master_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Primary Directory Nodes object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Primary Directory Nodes object
|
||||
api_instance.udm_computers_domaincontroller_master_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_master_object_search**
|
||||
> ComputersDomaincontrollerMasterList udm_computers_domaincontroller_master_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Primary Directory Nodes objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Primary Directory Nodes objects
|
||||
api_response = api_instance.udm_computers_domaincontroller_master_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerMasterList**](ComputersDomaincontrollerMasterList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_master_object_template**
|
||||
> ComputersDomaincontrollerMaster udm_computers_domaincontroller_master_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Primary Directory Node object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Primary Directory Node object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_domaincontroller_master_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerMaster**](ComputersDomaincontrollerMaster.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Primary Directory Node. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_master_object_update**
|
||||
> udm_computers_domaincontroller_master_object_update(dn, computers_domaincontroller_master, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Primary Directory Node object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerMasterApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_domaincontroller_master = openapi_client_udm.ComputersDomaincontrollerMaster() # ComputersDomaincontrollerMaster |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Primary Directory Node object (moving is currently not possible)
|
||||
api_instance.udm_computers_domaincontroller_master_object_update(dn, computers_domaincontroller_master, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerMasterApi->udm_computers_domaincontroller_master_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_domaincontroller_master** | [**ComputersDomaincontrollerMaster**](ComputersDomaincontrollerMaster.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersDomaincontrollerMasterList.md
Normal file
11
docs/ComputersDomaincontrollerMasterList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersDomaincontrollerMasterList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersDomaincontrollerMasterListEmbedded**](ComputersDomaincontrollerMasterListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersDomaincontrollerMasterListEmbedded.md
Normal file
11
docs/ComputersDomaincontrollerMasterListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersDomaincontrollerMasterListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersDomaincontrollerMaster]**](ComputersDomaincontrollerMaster.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersDomaincontrollerMasterOptions.md
Normal file
17
docs/ComputersDomaincontrollerMasterOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersDomaincontrollerMasterOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersDomaincontrollerMasterPolicies.md
Normal file
20
docs/ComputersDomaincontrollerMasterPolicies.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersDomaincontrollerMasterPolicies
|
||||
|
||||
Policies which apply for this object.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**policies_printserver** | **list[str]** | Policy: Print server | [optional]
|
||||
**policies_repositorysync** | **list[str]** | Policy: Repository synchronisation | [optional]
|
||||
**policies_nfsmounts** | **list[str]** | Policy: NFS mounts | [optional]
|
||||
**policies_umc** | **list[str]** | Policy: UMC | [optional]
|
||||
**policies_maintenance** | **list[str]** | Policy: Maintenance | [optional]
|
||||
**policies_release** | **list[str]** | Policy: Automatic updates | [optional]
|
||||
**policies_registry** | **list[str]** | Policy: Univention Configuration Registry | [optional]
|
||||
**policies_masterpackages** | **list[str]** | Policy: Packages for Primary/Backup Nodes | [optional]
|
||||
**policies_repositoryserver** | **list[str]** | Policy: Repository server | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersDomaincontrollerMasterRequest.md
Normal file
15
docs/ComputersDomaincontrollerMasterRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersDomaincontrollerMasterRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerMasterOptions**](ComputersDomaincontrollerMasterOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerMasterPolicies**](ComputersDomaincontrollerMasterPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersDomaincontrollerMasterRequestPatch.md
Normal file
14
docs/ComputersDomaincontrollerMasterRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersDomaincontrollerMasterRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerMasterOptions**](ComputersDomaincontrollerMasterOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerMasterPolicies**](ComputersDomaincontrollerMasterPolicies.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersDomaincontrollerMasterResponseMixin.md
Normal file
15
docs/ComputersDomaincontrollerMasterResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersDomaincontrollerMasterResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersDomaincontrollerSlave.md
Normal file
20
docs/ComputersDomaincontrollerSlave.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersDomaincontrollerSlave
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerSlaveOptions**](ComputersDomaincontrollerSlaveOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerSlavePolicies**](ComputersDomaincontrollerSlavePolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersDomaincontrollerSlaveApi.md
Normal file
686
docs/ComputersDomaincontrollerSlaveApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersDomaincontrollerSlaveApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_domaincontroller_slave_object**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object) | **GET** /computers/domaincontroller_slave/{dn} | Get a representation of the Replica Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_domaincontroller_slave_object_create**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object_create) | **POST** /computers/domaincontroller_slave/ | Create a new Replica Directory Node object
|
||||
[**udm_computers_domaincontroller_slave_object_modify**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object_modify) | **PUT** /computers/domaincontroller_slave/{dn} | Modify or move an Replica Directory Node object
|
||||
[**udm_computers_domaincontroller_slave_object_remove**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object_remove) | **DELETE** /computers/domaincontroller_slave/{dn} | Remove a Replica Directory Nodes object
|
||||
[**udm_computers_domaincontroller_slave_object_search**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object_search) | **GET** /computers/domaincontroller_slave/ | Search for Replica Directory Nodes objects
|
||||
[**udm_computers_domaincontroller_slave_object_template**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object_template) | **GET** /computers/domaincontroller_slave/add | Get a template for creating an Replica Directory Node object (contains all properties and their default values)
|
||||
[**udm_computers_domaincontroller_slave_object_update**](ComputersDomaincontrollerSlaveApi.md#udm_computers_domaincontroller_slave_object_update) | **PATCH** /computers/domaincontroller_slave/{dn} | Modify an Replica Directory Node object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object**
|
||||
> ComputersDomaincontrollerSlave udm_computers_domaincontroller_slave_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Replica Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Replica Directory Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_domaincontroller_slave_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerSlave**](ComputersDomaincontrollerSlave.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object_create**
|
||||
> InlineResponse201 udm_computers_domaincontroller_slave_object_create(computers_domaincontroller_slave, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Replica Directory Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
computers_domaincontroller_slave = openapi_client_udm.ComputersDomaincontrollerSlave() # ComputersDomaincontrollerSlave |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Replica Directory Node object
|
||||
api_response = api_instance.udm_computers_domaincontroller_slave_object_create(computers_domaincontroller_slave, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_domaincontroller_slave** | [**ComputersDomaincontrollerSlave**](ComputersDomaincontrollerSlave.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object_modify**
|
||||
> InlineResponse201 udm_computers_domaincontroller_slave_object_modify(dn, computers_domaincontroller_slave, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Replica Directory Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_domaincontroller_slave = openapi_client_udm.ComputersDomaincontrollerSlave() # ComputersDomaincontrollerSlave |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Replica Directory Node object
|
||||
api_response = api_instance.udm_computers_domaincontroller_slave_object_modify(dn, computers_domaincontroller_slave, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_domaincontroller_slave** | [**ComputersDomaincontrollerSlave**](ComputersDomaincontrollerSlave.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object_remove**
|
||||
> udm_computers_domaincontroller_slave_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Replica Directory Nodes object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Replica Directory Nodes object
|
||||
api_instance.udm_computers_domaincontroller_slave_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object_search**
|
||||
> ComputersDomaincontrollerSlaveList udm_computers_domaincontroller_slave_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Replica Directory Nodes objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Replica Directory Nodes objects
|
||||
api_response = api_instance.udm_computers_domaincontroller_slave_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerSlaveList**](ComputersDomaincontrollerSlaveList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object_template**
|
||||
> ComputersDomaincontrollerSlave udm_computers_domaincontroller_slave_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Replica Directory Node object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Replica Directory Node object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_domaincontroller_slave_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersDomaincontrollerSlave**](ComputersDomaincontrollerSlave.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Replica Directory Node. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_domaincontroller_slave_object_update**
|
||||
> udm_computers_domaincontroller_slave_object_update(dn, computers_domaincontroller_slave, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Replica Directory Node object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersDomaincontrollerSlaveApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_domaincontroller_slave = openapi_client_udm.ComputersDomaincontrollerSlave() # ComputersDomaincontrollerSlave |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Replica Directory Node object (moving is currently not possible)
|
||||
api_instance.udm_computers_domaincontroller_slave_object_update(dn, computers_domaincontroller_slave, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersDomaincontrollerSlaveApi->udm_computers_domaincontroller_slave_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_domaincontroller_slave** | [**ComputersDomaincontrollerSlave**](ComputersDomaincontrollerSlave.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersDomaincontrollerSlaveList.md
Normal file
11
docs/ComputersDomaincontrollerSlaveList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersDomaincontrollerSlaveList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersDomaincontrollerSlaveListEmbedded**](ComputersDomaincontrollerSlaveListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersDomaincontrollerSlaveListEmbedded.md
Normal file
11
docs/ComputersDomaincontrollerSlaveListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersDomaincontrollerSlaveListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersDomaincontrollerSlave]**](ComputersDomaincontrollerSlave.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersDomaincontrollerSlaveOptions.md
Normal file
17
docs/ComputersDomaincontrollerSlaveOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersDomaincontrollerSlaveOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersDomaincontrollerSlavePolicies.md
Normal file
20
docs/ComputersDomaincontrollerSlavePolicies.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersDomaincontrollerSlavePolicies
|
||||
|
||||
Policies which apply for this object.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**policies_slavepackages** | **list[str]** | Policy: Packages for Replica Nodes | [optional]
|
||||
**policies_printserver** | **list[str]** | Policy: Print server | [optional]
|
||||
**policies_repositorysync** | **list[str]** | Policy: Repository synchronisation | [optional]
|
||||
**policies_nfsmounts** | **list[str]** | Policy: NFS mounts | [optional]
|
||||
**policies_umc** | **list[str]** | Policy: UMC | [optional]
|
||||
**policies_maintenance** | **list[str]** | Policy: Maintenance | [optional]
|
||||
**policies_release** | **list[str]** | Policy: Automatic updates | [optional]
|
||||
**policies_registry** | **list[str]** | Policy: Univention Configuration Registry | [optional]
|
||||
**policies_repositoryserver** | **list[str]** | Policy: Repository server | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersDomaincontrollerSlaveRequest.md
Normal file
15
docs/ComputersDomaincontrollerSlaveRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersDomaincontrollerSlaveRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerSlaveOptions**](ComputersDomaincontrollerSlaveOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerSlavePolicies**](ComputersDomaincontrollerSlavePolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersDomaincontrollerSlaveRequestPatch.md
Normal file
14
docs/ComputersDomaincontrollerSlaveRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersDomaincontrollerSlaveRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersDomaincontrollerSlaveOptions**](ComputersDomaincontrollerSlaveOptions.md) | | [optional]
|
||||
**policies** | [**ComputersDomaincontrollerSlavePolicies**](ComputersDomaincontrollerSlavePolicies.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersDomaincontrollerSlaveResponseMixin.md
Normal file
15
docs/ComputersDomaincontrollerSlaveResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersDomaincontrollerSlaveResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersIpmanagedclient.md
Normal file
20
docs/ComputersIpmanagedclient.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersIpmanagedclient
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersIpmanagedclientOptions**](ComputersIpmanagedclientOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersIpmanagedclientApi.md
Normal file
686
docs/ComputersIpmanagedclientApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersIpmanagedclientApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_ipmanagedclient_object**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object) | **GET** /computers/ipmanagedclient/{dn} | Get a representation of the IP client object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_ipmanagedclient_object_create**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object_create) | **POST** /computers/ipmanagedclient/ | Create a new IP client object
|
||||
[**udm_computers_ipmanagedclient_object_modify**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object_modify) | **PUT** /computers/ipmanagedclient/{dn} | Modify or move an IP client object
|
||||
[**udm_computers_ipmanagedclient_object_remove**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object_remove) | **DELETE** /computers/ipmanagedclient/{dn} | Remove a IP clients object
|
||||
[**udm_computers_ipmanagedclient_object_search**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object_search) | **GET** /computers/ipmanagedclient/ | Search for IP clients objects
|
||||
[**udm_computers_ipmanagedclient_object_template**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object_template) | **GET** /computers/ipmanagedclient/add | Get a template for creating an IP client object (contains all properties and their default values)
|
||||
[**udm_computers_ipmanagedclient_object_update**](ComputersIpmanagedclientApi.md#udm_computers_ipmanagedclient_object_update) | **PATCH** /computers/ipmanagedclient/{dn} | Modify an IP client object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_ipmanagedclient_object**
|
||||
> ComputersIpmanagedclient udm_computers_ipmanagedclient_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the IP client object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the IP client object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_ipmanagedclient_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersIpmanagedclient**](ComputersIpmanagedclient.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ipmanagedclient_object_create**
|
||||
> InlineResponse201 udm_computers_ipmanagedclient_object_create(computers_ipmanagedclient, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new IP client object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
computers_ipmanagedclient = openapi_client_udm.ComputersIpmanagedclient() # ComputersIpmanagedclient |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new IP client object
|
||||
api_response = api_instance.udm_computers_ipmanagedclient_object_create(computers_ipmanagedclient, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_ipmanagedclient** | [**ComputersIpmanagedclient**](ComputersIpmanagedclient.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ipmanagedclient_object_modify**
|
||||
> InlineResponse201 udm_computers_ipmanagedclient_object_modify(dn, computers_ipmanagedclient, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an IP client object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_ipmanagedclient = openapi_client_udm.ComputersIpmanagedclient() # ComputersIpmanagedclient |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an IP client object
|
||||
api_response = api_instance.udm_computers_ipmanagedclient_object_modify(dn, computers_ipmanagedclient, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_ipmanagedclient** | [**ComputersIpmanagedclient**](ComputersIpmanagedclient.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ipmanagedclient_object_remove**
|
||||
> udm_computers_ipmanagedclient_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a IP clients object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a IP clients object
|
||||
api_instance.udm_computers_ipmanagedclient_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ipmanagedclient_object_search**
|
||||
> ComputersIpmanagedclientList udm_computers_ipmanagedclient_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for IP clients objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for IP clients objects
|
||||
api_response = api_instance.udm_computers_ipmanagedclient_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersIpmanagedclientList**](ComputersIpmanagedclientList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ipmanagedclient_object_template**
|
||||
> ComputersIpmanagedclient udm_computers_ipmanagedclient_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an IP client object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an IP client object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_ipmanagedclient_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersIpmanagedclient**](ComputersIpmanagedclient.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new IP client. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ipmanagedclient_object_update**
|
||||
> udm_computers_ipmanagedclient_object_update(dn, computers_ipmanagedclient, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an IP client object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersIpmanagedclientApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_ipmanagedclient = openapi_client_udm.ComputersIpmanagedclient() # ComputersIpmanagedclient |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an IP client object (moving is currently not possible)
|
||||
api_instance.udm_computers_ipmanagedclient_object_update(dn, computers_ipmanagedclient, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersIpmanagedclientApi->udm_computers_ipmanagedclient_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_ipmanagedclient** | [**ComputersIpmanagedclient**](ComputersIpmanagedclient.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersIpmanagedclientList.md
Normal file
11
docs/ComputersIpmanagedclientList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersIpmanagedclientList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersIpmanagedclientListEmbedded**](ComputersIpmanagedclientListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersIpmanagedclientListEmbedded.md
Normal file
11
docs/ComputersIpmanagedclientListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersIpmanagedclientListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersIpmanagedclient]**](ComputersIpmanagedclient.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersIpmanagedclientOptions.md
Normal file
14
docs/ComputersIpmanagedclientOptions.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersIpmanagedclientOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersIpmanagedclientRequest.md
Normal file
15
docs/ComputersIpmanagedclientRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersIpmanagedclientRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersIpmanagedclientOptions**](ComputersIpmanagedclientOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersIpmanagedclientRequestPatch.md
Normal file
14
docs/ComputersIpmanagedclientRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersIpmanagedclientRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersIpmanagedclientOptions**](ComputersIpmanagedclientOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersIpmanagedclientResponseMixin.md
Normal file
15
docs/ComputersIpmanagedclientResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersIpmanagedclientResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersLinux.md
Normal file
20
docs/ComputersLinux.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersLinux
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersLinuxOptions**](ComputersLinuxOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersLinuxApi.md
Normal file
686
docs/ComputersLinuxApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersLinuxApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_linux_object**](ComputersLinuxApi.md#udm_computers_linux_object) | **GET** /computers/linux/{dn} | Get a representation of the Linux Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_linux_object_create**](ComputersLinuxApi.md#udm_computers_linux_object_create) | **POST** /computers/linux/ | Create a new Linux Computer object
|
||||
[**udm_computers_linux_object_modify**](ComputersLinuxApi.md#udm_computers_linux_object_modify) | **PUT** /computers/linux/{dn} | Modify or move an Linux Computer object
|
||||
[**udm_computers_linux_object_remove**](ComputersLinuxApi.md#udm_computers_linux_object_remove) | **DELETE** /computers/linux/{dn} | Remove a Linux Computers object
|
||||
[**udm_computers_linux_object_search**](ComputersLinuxApi.md#udm_computers_linux_object_search) | **GET** /computers/linux/ | Search for Linux Computers objects
|
||||
[**udm_computers_linux_object_template**](ComputersLinuxApi.md#udm_computers_linux_object_template) | **GET** /computers/linux/add | Get a template for creating an Linux Computer object (contains all properties and their default values)
|
||||
[**udm_computers_linux_object_update**](ComputersLinuxApi.md#udm_computers_linux_object_update) | **PATCH** /computers/linux/{dn} | Modify an Linux Computer object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_linux_object**
|
||||
> ComputersLinux udm_computers_linux_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Linux Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Linux Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_linux_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersLinux**](ComputersLinux.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_linux_object_create**
|
||||
> InlineResponse201 udm_computers_linux_object_create(computers_linux, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Linux Computer object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
computers_linux = openapi_client_udm.ComputersLinux() # ComputersLinux |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Linux Computer object
|
||||
api_response = api_instance.udm_computers_linux_object_create(computers_linux, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_linux** | [**ComputersLinux**](ComputersLinux.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_linux_object_modify**
|
||||
> InlineResponse201 udm_computers_linux_object_modify(dn, computers_linux, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Linux Computer object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_linux = openapi_client_udm.ComputersLinux() # ComputersLinux |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Linux Computer object
|
||||
api_response = api_instance.udm_computers_linux_object_modify(dn, computers_linux, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_linux** | [**ComputersLinux**](ComputersLinux.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_linux_object_remove**
|
||||
> udm_computers_linux_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Linux Computers object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Linux Computers object
|
||||
api_instance.udm_computers_linux_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_linux_object_search**
|
||||
> ComputersLinuxList udm_computers_linux_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Linux Computers objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Linux Computers objects
|
||||
api_response = api_instance.udm_computers_linux_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersLinuxList**](ComputersLinuxList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_linux_object_template**
|
||||
> ComputersLinux udm_computers_linux_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Linux Computer object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Linux Computer object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_linux_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersLinux**](ComputersLinux.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Linux Computer. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_linux_object_update**
|
||||
> udm_computers_linux_object_update(dn, computers_linux, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Linux Computer object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersLinuxApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_linux = openapi_client_udm.ComputersLinux() # ComputersLinux |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Linux Computer object (moving is currently not possible)
|
||||
api_instance.udm_computers_linux_object_update(dn, computers_linux, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersLinuxApi->udm_computers_linux_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_linux** | [**ComputersLinux**](ComputersLinux.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersLinuxList.md
Normal file
11
docs/ComputersLinuxList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersLinuxList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersLinuxListEmbedded**](ComputersLinuxListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersLinuxListEmbedded.md
Normal file
11
docs/ComputersLinuxListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersLinuxListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersLinux]**](ComputersLinux.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersLinuxOptions.md
Normal file
17
docs/ComputersLinuxOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersLinuxOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersLinuxRequest.md
Normal file
15
docs/ComputersLinuxRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersLinuxRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersLinuxOptions**](ComputersLinuxOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersLinuxRequestPatch.md
Normal file
14
docs/ComputersLinuxRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersLinuxRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersLinuxOptions**](ComputersLinuxOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersLinuxResponseMixin.md
Normal file
15
docs/ComputersLinuxResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersLinuxResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersMacos.md
Normal file
20
docs/ComputersMacos.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersMacos
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersMacosOptions**](ComputersMacosOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersMacosApi.md
Normal file
686
docs/ComputersMacosApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersMacosApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_macos_object**](ComputersMacosApi.md#udm_computers_macos_object) | **GET** /computers/macos/{dn} | Get a representation of the macOS Client object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_macos_object_create**](ComputersMacosApi.md#udm_computers_macos_object_create) | **POST** /computers/macos/ | Create a new macOS Client object
|
||||
[**udm_computers_macos_object_modify**](ComputersMacosApi.md#udm_computers_macos_object_modify) | **PUT** /computers/macos/{dn} | Modify or move an macOS Client object
|
||||
[**udm_computers_macos_object_remove**](ComputersMacosApi.md#udm_computers_macos_object_remove) | **DELETE** /computers/macos/{dn} | Remove a macOS Clients object
|
||||
[**udm_computers_macos_object_search**](ComputersMacosApi.md#udm_computers_macos_object_search) | **GET** /computers/macos/ | Search for macOS Clients objects
|
||||
[**udm_computers_macos_object_template**](ComputersMacosApi.md#udm_computers_macos_object_template) | **GET** /computers/macos/add | Get a template for creating an macOS Client object (contains all properties and their default values)
|
||||
[**udm_computers_macos_object_update**](ComputersMacosApi.md#udm_computers_macos_object_update) | **PATCH** /computers/macos/{dn} | Modify an macOS Client object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_macos_object**
|
||||
> ComputersMacos udm_computers_macos_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the macOS Client object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the macOS Client object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_macos_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersMacos**](ComputersMacos.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_macos_object_create**
|
||||
> InlineResponse201 udm_computers_macos_object_create(computers_macos, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new macOS Client object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
computers_macos = openapi_client_udm.ComputersMacos() # ComputersMacos |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new macOS Client object
|
||||
api_response = api_instance.udm_computers_macos_object_create(computers_macos, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_macos** | [**ComputersMacos**](ComputersMacos.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_macos_object_modify**
|
||||
> InlineResponse201 udm_computers_macos_object_modify(dn, computers_macos, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an macOS Client object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_macos = openapi_client_udm.ComputersMacos() # ComputersMacos |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an macOS Client object
|
||||
api_response = api_instance.udm_computers_macos_object_modify(dn, computers_macos, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_macos** | [**ComputersMacos**](ComputersMacos.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_macos_object_remove**
|
||||
> udm_computers_macos_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a macOS Clients object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a macOS Clients object
|
||||
api_instance.udm_computers_macos_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_macos_object_search**
|
||||
> ComputersMacosList udm_computers_macos_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for macOS Clients objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for macOS Clients objects
|
||||
api_response = api_instance.udm_computers_macos_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersMacosList**](ComputersMacosList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_macos_object_template**
|
||||
> ComputersMacos udm_computers_macos_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an macOS Client object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an macOS Client object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_macos_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersMacos**](ComputersMacos.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new macOS Client. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_macos_object_update**
|
||||
> udm_computers_macos_object_update(dn, computers_macos, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an macOS Client object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMacosApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_macos = openapi_client_udm.ComputersMacos() # ComputersMacos |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an macOS Client object (moving is currently not possible)
|
||||
api_instance.udm_computers_macos_object_update(dn, computers_macos, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMacosApi->udm_computers_macos_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_macos** | [**ComputersMacos**](ComputersMacos.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersMacosList.md
Normal file
11
docs/ComputersMacosList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersMacosList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersMacosListEmbedded**](ComputersMacosListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersMacosListEmbedded.md
Normal file
11
docs/ComputersMacosListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersMacosListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersMacos]**](ComputersMacos.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersMacosOptions.md
Normal file
17
docs/ComputersMacosOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersMacosOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersMacosRequest.md
Normal file
15
docs/ComputersMacosRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersMacosRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersMacosOptions**](ComputersMacosOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersMacosRequestPatch.md
Normal file
14
docs/ComputersMacosRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersMacosRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersMacosOptions**](ComputersMacosOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersMacosResponseMixin.md
Normal file
15
docs/ComputersMacosResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersMacosResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersMemberserver.md
Normal file
20
docs/ComputersMemberserver.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersMemberserver
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersMemberserverOptions**](ComputersMemberserverOptions.md) | | [optional]
|
||||
**policies** | [**ComputersMemberserverPolicies**](ComputersMemberserverPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersMemberserverApi.md
Normal file
686
docs/ComputersMemberserverApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersMemberserverApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_memberserver_object**](ComputersMemberserverApi.md#udm_computers_memberserver_object) | **GET** /computers/memberserver/{dn} | Get a representation of the Managed Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_memberserver_object_create**](ComputersMemberserverApi.md#udm_computers_memberserver_object_create) | **POST** /computers/memberserver/ | Create a new Managed Node object
|
||||
[**udm_computers_memberserver_object_modify**](ComputersMemberserverApi.md#udm_computers_memberserver_object_modify) | **PUT** /computers/memberserver/{dn} | Modify or move an Managed Node object
|
||||
[**udm_computers_memberserver_object_remove**](ComputersMemberserverApi.md#udm_computers_memberserver_object_remove) | **DELETE** /computers/memberserver/{dn} | Remove a Managed Nodes object
|
||||
[**udm_computers_memberserver_object_search**](ComputersMemberserverApi.md#udm_computers_memberserver_object_search) | **GET** /computers/memberserver/ | Search for Managed Nodes objects
|
||||
[**udm_computers_memberserver_object_template**](ComputersMemberserverApi.md#udm_computers_memberserver_object_template) | **GET** /computers/memberserver/add | Get a template for creating an Managed Node object (contains all properties and their default values)
|
||||
[**udm_computers_memberserver_object_update**](ComputersMemberserverApi.md#udm_computers_memberserver_object_update) | **PATCH** /computers/memberserver/{dn} | Modify an Managed Node object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_memberserver_object**
|
||||
> ComputersMemberserver udm_computers_memberserver_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Managed Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Managed Node object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_memberserver_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersMemberserver**](ComputersMemberserver.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_memberserver_object_create**
|
||||
> InlineResponse201 udm_computers_memberserver_object_create(computers_memberserver, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Managed Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
computers_memberserver = openapi_client_udm.ComputersMemberserver() # ComputersMemberserver |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Managed Node object
|
||||
api_response = api_instance.udm_computers_memberserver_object_create(computers_memberserver, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_memberserver** | [**ComputersMemberserver**](ComputersMemberserver.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_memberserver_object_modify**
|
||||
> InlineResponse201 udm_computers_memberserver_object_modify(dn, computers_memberserver, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Managed Node object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_memberserver = openapi_client_udm.ComputersMemberserver() # ComputersMemberserver |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Managed Node object
|
||||
api_response = api_instance.udm_computers_memberserver_object_modify(dn, computers_memberserver, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_memberserver** | [**ComputersMemberserver**](ComputersMemberserver.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_memberserver_object_remove**
|
||||
> udm_computers_memberserver_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Managed Nodes object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Managed Nodes object
|
||||
api_instance.udm_computers_memberserver_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_memberserver_object_search**
|
||||
> ComputersMemberserverList udm_computers_memberserver_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Managed Nodes objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Managed Nodes objects
|
||||
api_response = api_instance.udm_computers_memberserver_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersMemberserverList**](ComputersMemberserverList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_memberserver_object_template**
|
||||
> ComputersMemberserver udm_computers_memberserver_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Managed Node object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Managed Node object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_memberserver_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersMemberserver**](ComputersMemberserver.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Managed Node. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_memberserver_object_update**
|
||||
> udm_computers_memberserver_object_update(dn, computers_memberserver, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Managed Node object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersMemberserverApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_memberserver = openapi_client_udm.ComputersMemberserver() # ComputersMemberserver |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Managed Node object (moving is currently not possible)
|
||||
api_instance.udm_computers_memberserver_object_update(dn, computers_memberserver, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersMemberserverApi->udm_computers_memberserver_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_memberserver** | [**ComputersMemberserver**](ComputersMemberserver.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersMemberserverList.md
Normal file
11
docs/ComputersMemberserverList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersMemberserverList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersMemberserverListEmbedded**](ComputersMemberserverListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersMemberserverListEmbedded.md
Normal file
11
docs/ComputersMemberserverListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersMemberserverListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersMemberserver]**](ComputersMemberserver.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersMemberserverOptions.md
Normal file
17
docs/ComputersMemberserverOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersMemberserverOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
21
docs/ComputersMemberserverPolicies.md
Normal file
21
docs/ComputersMemberserverPolicies.md
Normal file
@ -0,0 +1,21 @@
|
||||
# ComputersMemberserverPolicies
|
||||
|
||||
Policies which apply for this object.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**policies_printserver** | **list[str]** | Policy: Print server | [optional]
|
||||
**policies_repositorysync** | **list[str]** | Policy: Repository synchronisation | [optional]
|
||||
**policies_nfsmounts** | **list[str]** | Policy: NFS mounts | [optional]
|
||||
**policies_memberpackages** | **list[str]** | Policy: Packages for Managed Nodes | [optional]
|
||||
**policies_umc** | **list[str]** | Policy: UMC | [optional]
|
||||
**policies_maintenance** | **list[str]** | Policy: Maintenance | [optional]
|
||||
**policies_release** | **list[str]** | Policy: Automatic updates | [optional]
|
||||
**policies_registry** | **list[str]** | Policy: Univention Configuration Registry | [optional]
|
||||
**policies_ldapserver** | **list[str]** | Policy: LDAP server | [optional]
|
||||
**policies_repositoryserver** | **list[str]** | Policy: Repository server | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersMemberserverRequest.md
Normal file
15
docs/ComputersMemberserverRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersMemberserverRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersMemberserverOptions**](ComputersMemberserverOptions.md) | | [optional]
|
||||
**policies** | [**ComputersMemberserverPolicies**](ComputersMemberserverPolicies.md) | | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersMemberserverRequestPatch.md
Normal file
14
docs/ComputersMemberserverRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersMemberserverRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersMemberserverOptions**](ComputersMemberserverOptions.md) | | [optional]
|
||||
**policies** | [**ComputersMemberserverPolicies**](ComputersMemberserverPolicies.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersMemberserverResponseMixin.md
Normal file
15
docs/ComputersMemberserverResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersMemberserverResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersTrustaccount.md
Normal file
20
docs/ComputersTrustaccount.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersTrustaccount
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersTrustaccountOptions**](ComputersTrustaccountOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersTrustaccountApi.md
Normal file
686
docs/ComputersTrustaccountApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersTrustaccountApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_trustaccount_object**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object) | **GET** /computers/trustaccount/{dn} | Get a representation of the Domain trust account object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_trustaccount_object_create**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object_create) | **POST** /computers/trustaccount/ | Create a new Domain trust account object
|
||||
[**udm_computers_trustaccount_object_modify**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object_modify) | **PUT** /computers/trustaccount/{dn} | Modify or move an Domain trust account object
|
||||
[**udm_computers_trustaccount_object_remove**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object_remove) | **DELETE** /computers/trustaccount/{dn} | Remove a Domain trust accounts object
|
||||
[**udm_computers_trustaccount_object_search**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object_search) | **GET** /computers/trustaccount/ | Search for Domain trust accounts objects
|
||||
[**udm_computers_trustaccount_object_template**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object_template) | **GET** /computers/trustaccount/add | Get a template for creating an Domain trust account object (contains all properties and their default values)
|
||||
[**udm_computers_trustaccount_object_update**](ComputersTrustaccountApi.md#udm_computers_trustaccount_object_update) | **PATCH** /computers/trustaccount/{dn} | Modify an Domain trust account object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_trustaccount_object**
|
||||
> ComputersTrustaccount udm_computers_trustaccount_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Domain trust account object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Domain trust account object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_trustaccount_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersTrustaccount**](ComputersTrustaccount.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_trustaccount_object_create**
|
||||
> InlineResponse201 udm_computers_trustaccount_object_create(computers_trustaccount, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Domain trust account object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
computers_trustaccount = openapi_client_udm.ComputersTrustaccount() # ComputersTrustaccount |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Domain trust account object
|
||||
api_response = api_instance.udm_computers_trustaccount_object_create(computers_trustaccount, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_trustaccount** | [**ComputersTrustaccount**](ComputersTrustaccount.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_trustaccount_object_modify**
|
||||
> InlineResponse201 udm_computers_trustaccount_object_modify(dn, computers_trustaccount, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Domain trust account object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_trustaccount = openapi_client_udm.ComputersTrustaccount() # ComputersTrustaccount |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Domain trust account object
|
||||
api_response = api_instance.udm_computers_trustaccount_object_modify(dn, computers_trustaccount, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_trustaccount** | [**ComputersTrustaccount**](ComputersTrustaccount.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_trustaccount_object_remove**
|
||||
> udm_computers_trustaccount_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Domain trust accounts object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Domain trust accounts object
|
||||
api_instance.udm_computers_trustaccount_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_trustaccount_object_search**
|
||||
> ComputersTrustaccountList udm_computers_trustaccount_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Domain trust accounts objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Domain trust accounts objects
|
||||
api_response = api_instance.udm_computers_trustaccount_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersTrustaccountList**](ComputersTrustaccountList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_trustaccount_object_template**
|
||||
> ComputersTrustaccount udm_computers_trustaccount_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Domain trust account object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Domain trust account object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_trustaccount_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersTrustaccount**](ComputersTrustaccount.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Domain trust account. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_trustaccount_object_update**
|
||||
> udm_computers_trustaccount_object_update(dn, computers_trustaccount, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Domain trust account object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersTrustaccountApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_trustaccount = openapi_client_udm.ComputersTrustaccount() # ComputersTrustaccount |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Domain trust account object (moving is currently not possible)
|
||||
api_instance.udm_computers_trustaccount_object_update(dn, computers_trustaccount, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersTrustaccountApi->udm_computers_trustaccount_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_trustaccount** | [**ComputersTrustaccount**](ComputersTrustaccount.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersTrustaccountList.md
Normal file
11
docs/ComputersTrustaccountList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersTrustaccountList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersTrustaccountListEmbedded**](ComputersTrustaccountListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersTrustaccountListEmbedded.md
Normal file
11
docs/ComputersTrustaccountListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersTrustaccountListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersTrustaccount]**](ComputersTrustaccount.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
12
docs/ComputersTrustaccountOptions.md
Normal file
12
docs/ComputersTrustaccountOptions.md
Normal file
@ -0,0 +1,12 @@
|
||||
# ComputersTrustaccountOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersTrustaccountRequest.md
Normal file
15
docs/ComputersTrustaccountRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersTrustaccountRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersTrustaccountOptions**](ComputersTrustaccountOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersTrustaccountRequestPatch.md
Normal file
14
docs/ComputersTrustaccountRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersTrustaccountRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersTrustaccountOptions**](ComputersTrustaccountOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersTrustaccountResponseMixin.md
Normal file
15
docs/ComputersTrustaccountResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersTrustaccountResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersUbuntu.md
Normal file
20
docs/ComputersUbuntu.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersUbuntu
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersUbuntuOptions**](ComputersUbuntuOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
686
docs/ComputersUbuntuApi.md
Normal file
686
docs/ComputersUbuntuApi.md
Normal file
@ -0,0 +1,686 @@
|
||||
# openapi_client_udm.ComputersUbuntuApi
|
||||
|
||||
All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**udm_computers_ubuntu_object**](ComputersUbuntuApi.md#udm_computers_ubuntu_object) | **GET** /computers/ubuntu/{dn} | Get a representation of the Ubuntu Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
[**udm_computers_ubuntu_object_create**](ComputersUbuntuApi.md#udm_computers_ubuntu_object_create) | **POST** /computers/ubuntu/ | Create a new Ubuntu Computer object
|
||||
[**udm_computers_ubuntu_object_modify**](ComputersUbuntuApi.md#udm_computers_ubuntu_object_modify) | **PUT** /computers/ubuntu/{dn} | Modify or move an Ubuntu Computer object
|
||||
[**udm_computers_ubuntu_object_remove**](ComputersUbuntuApi.md#udm_computers_ubuntu_object_remove) | **DELETE** /computers/ubuntu/{dn} | Remove a Ubuntu Computers object
|
||||
[**udm_computers_ubuntu_object_search**](ComputersUbuntuApi.md#udm_computers_ubuntu_object_search) | **GET** /computers/ubuntu/ | Search for Ubuntu Computers objects
|
||||
[**udm_computers_ubuntu_object_template**](ComputersUbuntuApi.md#udm_computers_ubuntu_object_template) | **GET** /computers/ubuntu/add | Get a template for creating an Ubuntu Computer object (contains all properties and their default values)
|
||||
[**udm_computers_ubuntu_object_update**](ComputersUbuntuApi.md#udm_computers_ubuntu_object_update) | **PATCH** /computers/ubuntu/{dn} | Modify an Ubuntu Computer object (moving is currently not possible)
|
||||
|
||||
|
||||
# **udm_computers_ubuntu_object**
|
||||
> ComputersUbuntu udm_computers_ubuntu_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a representation of the Ubuntu Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a representation of the Ubuntu Computer object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
|
||||
api_response = api_instance.udm_computers_ubuntu_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersUbuntu**](ComputersUbuntu.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Success | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ubuntu_object_create**
|
||||
> InlineResponse201 udm_computers_ubuntu_object_create(computers_ubuntu, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Create a new Ubuntu Computer object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
computers_ubuntu = openapi_client_udm.ComputersUbuntu() # ComputersUbuntu |
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Create a new Ubuntu Computer object
|
||||
api_response = api_instance.udm_computers_ubuntu_object_create(computers_ubuntu, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object_create: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**computers_ubuntu** | [**ComputersUbuntu**](ComputersUbuntu.md)| |
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Object created | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ubuntu_object_modify**
|
||||
> InlineResponse201 udm_computers_ubuntu_object_modify(dn, computers_ubuntu, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify or move an Ubuntu Computer object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_ubuntu = openapi_client_udm.ComputersUbuntu() # ComputersUbuntu |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify or move an Ubuntu Computer object
|
||||
api_response = api_instance.udm_computers_ubuntu_object_modify(dn, computers_ubuntu, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object_modify: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_ubuntu** | [**ComputersUbuntu**](ComputersUbuntu.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**202** | Accepted: asynchronous move or rename operation started. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ubuntu_object_remove**
|
||||
> udm_computers_ubuntu_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Remove a Ubuntu Computers object
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
cleanup = True # bool | Whether to perform a cleanup (e.g. of temporary objects, locks, etc). (optional) (default to True)
|
||||
recursive = True # bool | Whether to remove referring objects (e.g. DNS or DHCP references). (optional) (default to True)
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Remove a Ubuntu Computers object
|
||||
api_instance.udm_computers_ubuntu_object_remove(dn, cleanup=cleanup, recursive=recursive, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object_remove: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**cleanup** | **bool**| Whether to perform a cleanup (e.g. of temporary objects, locks, etc). | [optional] [default to True]
|
||||
**recursive** | **bool**| Whether to remove referring objects (e.g. DNS or DHCP references). | [optional] [default to True]
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Object deleted | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ubuntu_object_search**
|
||||
> ComputersUbuntuList udm_computers_ubuntu_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Search for Ubuntu Computers objects
|
||||
|
||||
Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
|
||||
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
|
||||
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
|
||||
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
|
||||
limit = # int | **Broken/Experimental**: How many results should be shown per page. (optional)
|
||||
page = 1 # int | **Broken/Experimental**: The search page, starting at one. (optional) (default to 1)
|
||||
dir = 'ASC' # str | **Broken/Experimental**: The Sort direction (ASC or DESC). (optional) (default to 'ASC')
|
||||
by = 'by_example' # str | **Broken/Experimental**: Sort the search result by the specified property. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Search for Ubuntu Computers objects
|
||||
api_response = api_instance.udm_computers_ubuntu_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, limit=limit, page=page, dir=dir, by=by, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object_search: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filter** | **str**| A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. | [optional] [default to '']
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**scope** | **str**| The LDAP search scope (sub, base, one). | [optional] [default to 'sub']
|
||||
**query** | [**dict(str, object)**](object.md)| The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. | [optional]
|
||||
**hidden** | **bool**| Include hidden/system objects in the response. | [optional] [default to True]
|
||||
**properties** | [**list[str]**](str.md)| The properties which should be returned, if not given all properties are returned. | [optional] [default to ["*"]]
|
||||
**limit** | **int**| **Broken/Experimental**: How many results should be shown per page. | [optional]
|
||||
**page** | **int**| **Broken/Experimental**: The search page, starting at one. | [optional] [default to 1]
|
||||
**dir** | **str**| **Broken/Experimental**: The Sort direction (ASC or DESC). | [optional] [default to 'ASC']
|
||||
**by** | **str**| **Broken/Experimental**: Sort the search result by the specified property. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersUbuntuList**](ComputersUbuntuList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfull search (if query parameters were given) or a object type overview. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ubuntu_object_template**
|
||||
> ComputersUbuntu udm_computers_ubuntu_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Get a template for creating an Ubuntu Computer object (contains all properties and their default values)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
|
||||
superordinate = 'null' # str | The superordinate DN of the object to create. `position` is sufficient. (optional) (default to 'null')
|
||||
template = 'null' # str | **Experimental**: A |UDM| template object. (optional) (default to 'null')
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Get a template for creating an Ubuntu Computer object (contains all properties and their default values)
|
||||
api_response = api_instance.udm_computers_ubuntu_object_template(position=position, superordinate=superordinate, template=template, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object_template: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**position** | **str**| Position which is used as search base. | [optional] [default to 'null']
|
||||
**superordinate** | **str**| The superordinate DN of the object to create. `position` is sufficient. | [optional] [default to 'null']
|
||||
**template** | **str**| **Experimental**: A |UDM| template object. | [optional] [default to 'null']
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ComputersUbuntu**](ComputersUbuntu.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**200** | Successfully received a template suitable for creation of a new Ubuntu Computer. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **udm_computers_ubuntu_object_update**
|
||||
> udm_computers_ubuntu_object_update(dn, computers_ubuntu, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
|
||||
Modify an Ubuntu Computer object (moving is currently not possible)
|
||||
|
||||
### Example
|
||||
|
||||
* Basic Authentication (basic):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import openapi_client_udm
|
||||
from openapi_client_udm.rest import ApiException
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure HTTP basic authorization: basic
|
||||
configuration = openapi_client_udm.Configuration(
|
||||
username = 'YOUR_USERNAME',
|
||||
password = 'YOUR_PASSWORD'
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client_udm.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client_udm.ComputersUbuntuApi(api_client)
|
||||
dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
|
||||
computers_ubuntu = openapi_client_udm.ComputersUbuntu() # ComputersUbuntu |
|
||||
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
|
||||
user_agent = '' # str | The user agent. (optional)
|
||||
accept_language = '' # str | The accepted response languages. (optional)
|
||||
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
|
||||
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
|
||||
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)
|
||||
|
||||
try:
|
||||
# Modify an Ubuntu Computer object (moving is currently not possible)
|
||||
api_instance.udm_computers_ubuntu_object_update(dn, computers_ubuntu, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ComputersUbuntuApi->udm_computers_ubuntu_object_update: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). |
|
||||
**computers_ubuntu** | [**ComputersUbuntu**](ComputersUbuntu.md)| |
|
||||
**if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional]
|
||||
**user_agent** | **str**| The user agent. | [optional]
|
||||
**accept_language** | **str**| The accepted response languages. | [optional]
|
||||
**if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional]
|
||||
**if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional]
|
||||
**x_request_id** | **str**| A request-ID used for logging and tracing. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[basic](../README.md#basic)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/hal+json, text/html
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**400** | Bad request syntax. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**401** | Unauthorized. No Authorization provided or wrong credentials. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**403** | Forbidden (e.g. unsupported operation) | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**422** | Validation of input parameters failed. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**500** | Internal server errror. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
**503** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**502** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**504** | (LDAP) Server not available. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Retry-After - <br> |
|
||||
**204** | Success. No response data. A link to the modified resource in the `Location` header. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> * Location - <br> * Etag - <br> * Last-Modified - <br> |
|
||||
**404** | Object not found. | * Cache-Control - <br> * Expires - <br> * Vary - <br> * Content-Language - <br> * Link - <br> * X-Request-Id - <br> |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
11
docs/ComputersUbuntuList.md
Normal file
11
docs/ComputersUbuntuList.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersUbuntuList
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ComputersUbuntuListEmbedded**](ComputersUbuntuListEmbedded.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
11
docs/ComputersUbuntuListEmbedded.md
Normal file
11
docs/ComputersUbuntuListEmbedded.md
Normal file
@ -0,0 +1,11 @@
|
||||
# ComputersUbuntuListEmbedded
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**udmobject** | [**list[ComputersUbuntu]**](ComputersUbuntu.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
17
docs/ComputersUbuntuOptions.md
Normal file
17
docs/ComputersUbuntuOptions.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ComputersUbuntuOptions
|
||||
|
||||
Object type specific `UDM` options.
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**posix** | **bool** | Posix account | [optional] [default to True]
|
||||
**kerberos** | **bool** | Kerberos principal | [optional] [default to True]
|
||||
**samba** | **bool** | Samba account | [optional] [default to True]
|
||||
**pki** | **bool** | Public key infrastructure account | [optional] [default to False]
|
||||
**nagios** | **bool** | Nagios support | [optional] [default to False]
|
||||
**radius_authenticator** | **bool** | RADIUS Authenticator | [optional] [default to False]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersUbuntuRequest.md
Normal file
15
docs/ComputersUbuntuRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersUbuntuRequest
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersUbuntuOptions**](ComputersUbuntuOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
14
docs/ComputersUbuntuRequestPatch.md
Normal file
14
docs/ComputersUbuntuRequestPatch.md
Normal file
@ -0,0 +1,14 @@
|
||||
# ComputersUbuntuRequestPatch
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersUbuntuOptions**](ComputersUbuntuOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
15
docs/ComputersUbuntuResponseMixin.md
Normal file
15
docs/ComputersUbuntuResponseMixin.md
Normal file
@ -0,0 +1,15 @@
|
||||
# ComputersUbuntuResponseMixin
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
20
docs/ComputersWindows.md
Normal file
20
docs/ComputersWindows.md
Normal file
@ -0,0 +1,20 @@
|
||||
# ComputersWindows
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dn** | **str** | The LDAP Distinguished Name (DN). | [optional] [readonly]
|
||||
**properties** | **dict(str, object)** | Object type specific `UDM` properties. | [optional]
|
||||
**options** | [**ComputersWindowsOptions**](ComputersWindowsOptions.md) | | [optional]
|
||||
**policies** | **dict(str, object)** | Policies which apply for this object. | [optional]
|
||||
**position** | **str** | DN of LDAP node below which the object is located. Changing this causes a move of the object. When changing no other changes are applied. | [optional]
|
||||
**links** | [**Links**](Links.md) | | [optional]
|
||||
**embedded** | **dict(str, object)** | Hypertext Application Language (HAL) embedded resources. | [optional] [readonly]
|
||||
**uuid** | **str** | The LDAP Entry-UUID. | [optional] [readonly]
|
||||
**object_type** | **str** | The UDM Object-Type. | [optional] [readonly]
|
||||
**uri** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user