pulp_ansible_client
PulpAnsibleClient - the Ruby gem for the Pulp 3 API
Fetch, Upload, Organize, and Distribute Software Packages
This SDK is automatically generated by the OpenAPI Generator project:
- API version: v3
- Package version: 0.4.2
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://pulpproject.org
Installation
Build a gem
To build the Ruby code into a gem:
gem build pulp_ansible_client.gemspec
Then either install the gem locally:
gem install ./pulp_ansible_client-0.4.2.gem
(for development, run gem install --dev ./pulp_ansible_client-0.4.2.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'pulp_ansible_client', '~> 0.4.2'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'pulp_ansible_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'pulp_ansible_client'
# Setup authorization
PulpAnsibleClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR_USERNAME'
config.password = 'YOUR_PASSWORD'
end
api_instance = PulpAnsibleClient::AnsibleCollectionsApi.new
opts = {
limit: 56, # Integer | Number of results to return per page.
name: 'name_example', # String | name
namespace: 'namespace_example', # String | namespace
offset: 56, # Integer | The initial index from which to return the results.
ordering: 'ordering_example', # String | Which field to use when ordering the results.
fields: 'fields_example', # String | A list of fields to include in the response.
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}
begin
#List collections
result = api_instance.list(opts)
p result
rescue PulpAnsibleClient::ApiError => e
puts "Exception when calling AnsibleCollectionsApi->list: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://pulp
Class | Method | HTTP request | Description |
---|---|---|---|
PulpAnsibleClient::AnsibleCollectionsApi | list | GET /pulp/api/v3/ansible/collections/ | List collections |
PulpAnsibleClient::AnsibleCollectionsApi | upload_collection | POST /ansible/collections/ | Upload a collection |
PulpAnsibleClient::ApiCollectionsApi | get | GET ansible_collection_hrefapi/v2/collections/ | |
PulpAnsibleClient::ApiCollectionsApi | post | POST ansible_collection_hrefapi/v2/collections/ | |
PulpAnsibleClient::ApiRolesApi | get | GET ansible_role_hrefapi/v1/roles/ | |
PulpAnsibleClient::CollectionImportApi | read | GET ansible_collection_import_href | Inspect a collection import |
PulpAnsibleClient::ContentCollectionVersionsApi | create | POST /pulp/api/v3/content/ansible/collection_versions/ | Create a collection version |
PulpAnsibleClient::ContentCollectionVersionsApi | list | GET /pulp/api/v3/content/ansible/collection_versions/ | List collection versions |
PulpAnsibleClient::ContentCollectionVersionsApi | read | GET ansible_collection_version_href | Inspect a collection version |
PulpAnsibleClient::ContentRolesApi | create | POST /pulp/api/v3/content/ansible/roles/ | Create a role |
PulpAnsibleClient::ContentRolesApi | list | GET /pulp/api/v3/content/ansible/roles/ | List roles |
PulpAnsibleClient::ContentRolesApi | read | GET ansible_role_href | Inspect a role |
PulpAnsibleClient::DistributionsAnsibleApi | create | POST /pulp/api/v3/distributions/ansible/ansible/ | Create an ansible distribution |
PulpAnsibleClient::DistributionsAnsibleApi | delete | DELETE ansible_ansible_distribution_href | Delete an ansible distribution |
PulpAnsibleClient::DistributionsAnsibleApi | list | GET /pulp/api/v3/distributions/ansible/ansible/ | List ansible distributions |
PulpAnsibleClient::DistributionsAnsibleApi | partial_update | PATCH ansible_ansible_distribution_href | Update an ansible distribution |
PulpAnsibleClient::DistributionsAnsibleApi | read | GET ansible_ansible_distribution_href | Inspect an ansible distribution |
PulpAnsibleClient::DistributionsAnsibleApi | update | PUT ansible_ansible_distribution_href | Update an ansible distribution |
PulpAnsibleClient::GalaxyDetailApi | get | GET ansible_collection_href | |
PulpAnsibleClient::PulpAnsibleApiApi | get | GET /pulp_ansible/galaxy/path/api/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi | list | GET /pulp_ansible/galaxy/path/api/v3/collections/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi | read | GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi | update | PUT /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiV2VersionsApi | get | GET /pulp_ansible/galaxy/path/api/v2/collections/namespace/name/versions/version/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi | create | POST /pulp_ansible/galaxy/path/api/v3/artifacts/collections/ | Upload a collection |
PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsCertifiedApi | set_certified | PUT /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/version/certified/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi | read | GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/version/docs-blob/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi | list | GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/ | |
PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi | read | GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/version/ | |
PulpAnsibleClient::PulpAnsibleTagsApi | list | GET /pulp/api/v3/pulp_ansible/tags/ | List tags |
PulpAnsibleClient::RemotesCollectionApi | create | POST /pulp/api/v3/remotes/ansible/collection/ | Create a collection remote |
PulpAnsibleClient::RemotesCollectionApi | delete | DELETE ansible_collection_remote_href | Delete a collection remote |
PulpAnsibleClient::RemotesCollectionApi | list | GET /pulp/api/v3/remotes/ansible/collection/ | List collection remotes |
PulpAnsibleClient::RemotesCollectionApi | partial_update | PATCH ansible_collection_remote_href | Update a collection remote |
PulpAnsibleClient::RemotesCollectionApi | read | GET ansible_collection_remote_href | Inspect a collection remote |
PulpAnsibleClient::RemotesCollectionApi | update | PUT ansible_collection_remote_href | Update a collection remote |
PulpAnsibleClient::RemotesRoleApi | create | POST /pulp/api/v3/remotes/ansible/role/ | Create a role remote |
PulpAnsibleClient::RemotesRoleApi | delete | DELETE ansible_role_remote_href | Delete a role remote |
PulpAnsibleClient::RemotesRoleApi | list | GET /pulp/api/v3/remotes/ansible/role/ | List role remotes |
PulpAnsibleClient::RemotesRoleApi | partial_update | PATCH ansible_role_remote_href | Update a role remote |
PulpAnsibleClient::RemotesRoleApi | read | GET ansible_role_remote_href | Inspect a role remote |
PulpAnsibleClient::RemotesRoleApi | update | PUT ansible_role_remote_href | Update a role remote |
PulpAnsibleClient::RepositoriesAnsibleApi | create | POST /pulp/api/v3/repositories/ansible/ansible/ | Create an ansible repository |
PulpAnsibleClient::RepositoriesAnsibleApi | delete | DELETE ansible_ansible_repository_href | Delete an ansible repository |
PulpAnsibleClient::RepositoriesAnsibleApi | list | GET /pulp/api/v3/repositories/ansible/ansible/ | List ansible repositorys |
PulpAnsibleClient::RepositoriesAnsibleApi | modify | POST ansible_ansible_repository_hrefmodify/ | Modify Repository Content |
PulpAnsibleClient::RepositoriesAnsibleApi | partial_update | PATCH ansible_ansible_repository_href | Update an ansible repository |
PulpAnsibleClient::RepositoriesAnsibleApi | read | GET ansible_ansible_repository_href | Inspect an ansible repository |
PulpAnsibleClient::RepositoriesAnsibleApi | sync | POST ansible_ansible_repository_hrefsync/ | |
PulpAnsibleClient::RepositoriesAnsibleApi | update | PUT ansible_ansible_repository_href | Update an ansible repository |
PulpAnsibleClient::RepositoriesAnsibleVersionsApi | delete | DELETE ansible_ansible_repository_version_href | Delete a repository version |
PulpAnsibleClient::RepositoriesAnsibleVersionsApi | list | GET ansible_ansible_repository_hrefversions/ | List repository versions |
PulpAnsibleClient::RepositoriesAnsibleVersionsApi | read | GET ansible_ansible_repository_version_href | Inspect a repository version |
PulpAnsibleClient::RepositoriesAnsibleVersionsApi | repair | POST ansible_ansible_repository_version_hrefrepair/ | |
PulpAnsibleClient::VersionsApi | get | GET ansible_role_hrefversions/ | |
PulpAnsibleClient::VersionsApi | get_0 | GET ansible_collection_version_hrefversions/ |
Documentation for Models
- PulpAnsibleClient::AnsibleAnsibleDistribution
- PulpAnsibleClient::AnsibleAnsibleDistributionResponse
- PulpAnsibleClient::AnsibleAnsibleRepository
- PulpAnsibleClient::AnsibleAnsibleRepositoryResponse
- PulpAnsibleClient::AnsibleCollectionRemote
- PulpAnsibleClient::AnsibleCollectionRemoteResponse
- PulpAnsibleClient::AnsibleCollectionResponse
- PulpAnsibleClient::AnsibleCollectionVersion
- PulpAnsibleClient::AnsibleCollectionVersionResponse
- PulpAnsibleClient::AnsibleRole
- PulpAnsibleClient::AnsibleRoleRemote
- PulpAnsibleClient::AnsibleRoleRemoteResponse
- PulpAnsibleClient::AnsibleRoleResponse
- PulpAnsibleClient::AnsibleTagResponse
- PulpAnsibleClient::AsyncOperationResponse
- PulpAnsibleClient::CertificationEnum
- PulpAnsibleClient::Collection
- PulpAnsibleClient::CollectionImportDetailResponse
- PulpAnsibleClient::CollectionMetadata
- PulpAnsibleClient::CollectionMetadataResponse
- PulpAnsibleClient::CollectionNamespace
- PulpAnsibleClient::CollectionNamespaceResponse
- PulpAnsibleClient::CollectionOneShot
- PulpAnsibleClient::CollectionRef
- PulpAnsibleClient::CollectionRefResponse
- PulpAnsibleClient::CollectionResponse
- PulpAnsibleClient::CollectionVersion
- PulpAnsibleClient::CollectionVersionDocsResponse
- PulpAnsibleClient::CollectionVersionResponse
- PulpAnsibleClient::ContentSummary
- PulpAnsibleClient::ContentSummaryResponse
- PulpAnsibleClient::GalaxyCollection
- PulpAnsibleClient::GalaxyCollectionResponse
- PulpAnsibleClient::GalaxyCollectionVersionResponse
- PulpAnsibleClient::GalaxyRoleResponse
- PulpAnsibleClient::GalaxyRoleVersionResponse
- PulpAnsibleClient::InlineResponse200
- PulpAnsibleClient::InlineResponse2001
- PulpAnsibleClient::InlineResponse20010
- PulpAnsibleClient::InlineResponse20011
- PulpAnsibleClient::InlineResponse20012
- PulpAnsibleClient::InlineResponse20013
- PulpAnsibleClient::InlineResponse20014
- PulpAnsibleClient::InlineResponse2002
- PulpAnsibleClient::InlineResponse2003
- PulpAnsibleClient::InlineResponse2004
- PulpAnsibleClient::InlineResponse2005
- PulpAnsibleClient::InlineResponse2006
- PulpAnsibleClient::InlineResponse2007
- PulpAnsibleClient::InlineResponse2008
- PulpAnsibleClient::InlineResponse2009
- PulpAnsibleClient::PatchedansibleAnsibleDistribution
- PulpAnsibleClient::PatchedansibleAnsibleRepository
- PulpAnsibleClient::PatchedansibleCollectionRemote
- PulpAnsibleClient::PatchedansibleRoleRemote
- PulpAnsibleClient::PolicyEnum
- PulpAnsibleClient::RepositoryAddRemoveContent
- PulpAnsibleClient::RepositorySyncURL
- PulpAnsibleClient::RepositoryVersion
- PulpAnsibleClient::RepositoryVersionResponse
- PulpAnsibleClient::TagResponse
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication