pulpcore.client.pulpcore.UpstreamPulpsApi
All URIs are relative to http://localhost:24817
Method | HTTP request | Description |
---|---|---|
add_role | POST {upstream_pulp_href}add_role/ | Add a role |
create | POST /pulp/api/v3/upstream-pulps/ | Create an upstream pulp |
delete | DELETE {upstream_pulp_href} | Delete an upstream pulp |
list | GET /pulp/api/v3/upstream-pulps/ | List upstream pulps |
list_roles | GET {upstream_pulp_href}list_roles/ | List roles |
my_permissions | GET {upstream_pulp_href}my_permissions/ | List user permissions |
partial_update | PATCH {upstream_pulp_href} | Update an upstream pulp |
read | GET {upstream_pulp_href} | Inspect an upstream pulp |
remove_role | POST {upstream_pulp_href}remove_role/ | Remove a role |
replicate | POST {upstream_pulp_href}replicate/ | Replicate |
update | PUT {upstream_pulp_href} | Update an upstream pulp |
add_role
NestedRoleResponse add_role(upstream_pulp_href, nested_role)
Add a role
Add a role for this object to users/groups.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole |
try:
# Add a role
api_response = api_instance.add_role(upstream_pulp_href, nested_role)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->add_role: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole |
try:
# Add a role
api_response = api_instance.add_role(upstream_pulp_href, nested_role)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->add_role: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
nested_role | NestedRole |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
create
UpstreamPulpResponse create(upstream_pulp)
Create an upstream pulp
API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp = pulpcore.client.pulpcore.UpstreamPulp() # UpstreamPulp |
try:
# Create an upstream pulp
api_response = api_instance.create(upstream_pulp)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->create: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp = pulpcore.client.pulpcore.UpstreamPulp() # UpstreamPulp |
try:
# Create an upstream pulp
api_response = api_instance.create(upstream_pulp)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->create: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp | UpstreamPulp |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
delete
delete(upstream_pulp_href)
Delete an upstream pulp
API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
try:
# Delete an upstream pulp
api_instance.delete(upstream_pulp_href)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->delete: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
try:
# Delete an upstream pulp
api_instance.delete(upstream_pulp_href)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->delete: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No response body | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
list
PaginatedUpstreamPulpResponseList list(limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
List upstream pulps
API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
limit = 56 # int | Number of results to return per page. (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# List upstream pulps
api_response = api_instance.list(limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->list: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
limit = 56 # int | Number of results to return per page. (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# List upstream pulps
api_response = api_instance.list(limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->list: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
fields | list[str] | A list of fields to include in the response. | [optional] |
exclude_fields | list[str] | A list of fields to exclude from the response. | [optional] |
Return type
PaginatedUpstreamPulpResponseList
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
list_roles
ObjectRolesResponse list_roles(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
List roles
List roles assigned to this object.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# List roles
api_response = api_instance.list_roles(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->list_roles: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# List roles
api_response = api_instance.list_roles(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->list_roles: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
fields | list[str] | A list of fields to include in the response. | [optional] |
exclude_fields | list[str] | A list of fields to exclude from the response. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
my_permissions
MyPermissionsResponse my_permissions(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
List user permissions
List permissions available to the current user on this object.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# List user permissions
api_response = api_instance.my_permissions(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->my_permissions: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# List user permissions
api_response = api_instance.my_permissions(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->my_permissions: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
fields | list[str] | A list of fields to include in the response. | [optional] |
exclude_fields | list[str] | A list of fields to exclude from the response. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
partial_update
UpstreamPulpResponse partial_update(upstream_pulp_href, patched_upstream_pulp)
Update an upstream pulp
API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
patched_upstream_pulp = pulpcore.client.pulpcore.PatchedUpstreamPulp() # PatchedUpstreamPulp |
try:
# Update an upstream pulp
api_response = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->partial_update: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
patched_upstream_pulp = pulpcore.client.pulpcore.PatchedUpstreamPulp() # PatchedUpstreamPulp |
try:
# Update an upstream pulp
api_response = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->partial_update: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
patched_upstream_pulp | PatchedUpstreamPulp |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
read
UpstreamPulpResponse read(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
Inspect an upstream pulp
API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect an upstream pulp
api_response = api_instance.read(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->read: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect an upstream pulp
api_response = api_instance.read(upstream_pulp_href, fields=fields, exclude_fields=exclude_fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->read: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
fields | list[str] | A list of fields to include in the response. | [optional] |
exclude_fields | list[str] | A list of fields to exclude from the response. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
remove_role
NestedRoleResponse remove_role(upstream_pulp_href, nested_role)
Remove a role
Remove a role for this object from users/groups.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole |
try:
# Remove a role
api_response = api_instance.remove_role(upstream_pulp_href, nested_role)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->remove_role: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole |
try:
# Remove a role
api_response = api_instance.remove_role(upstream_pulp_href, nested_role)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->remove_role: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
nested_role | NestedRole |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
replicate
TaskGroupOperationResponse replicate(upstream_pulp_href)
Replicate
Trigger an asynchronous repository replication task group. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
try:
# Replicate
api_response = api_instance.replicate(upstream_pulp_href)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->replicate: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
try:
# Replicate
api_response = api_instance.replicate(upstream_pulp_href)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->replicate: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
202 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]
update
UpstreamPulpResponse update(upstream_pulp_href, upstream_pulp)
Update an upstream pulp
API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
Example
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
upstream_pulp = pulpcore.client.pulpcore.UpstreamPulp() # UpstreamPulp |
try:
# Update an upstream pulp
api_response = api_instance.update(upstream_pulp_href, upstream_pulp)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->update: %s\n" % e)
- Api Key Authentication (cookieAuth):
from __future__ import print_function
import time
import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817"
)
# 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: basicAuth
configuration = pulpcore.client.pulpcore.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulpcore.Configuration(
host = "http://localhost:24817",
api_key = {
'sessionid': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
upstream_pulp_href = 'upstream_pulp_href_example' # str |
upstream_pulp = pulpcore.client.pulpcore.UpstreamPulp() # UpstreamPulp |
try:
# Update an upstream pulp
api_response = api_instance.update(upstream_pulp_href, upstream_pulp)
pprint(api_response)
except ApiException as e:
print("Exception when calling UpstreamPulpsApi->update: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
upstream_pulp_href | str | ||
upstream_pulp | UpstreamPulp |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to HOME]