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.16.1
  • 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.16.1.gem

(for development, run gem install --dev ./pulp_ansible_client-0.16.1.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.16.1'

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 | 
  namespace: 'namespace_example', # String | 
  offset: 56, # Integer | The initial index from which to return the results.
  ordering: ['ordering_example'], # Array<String> | Ordering
  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['exclude_fields_example'] # Array<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 https://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::AnsibleCopyApi copy_content POST /pulp/api/v3/ansible/copy/ Copy content
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::ContentCollectionDeprecationsApi create POST /pulp/api/v3/content/ansible/collection_deprecations/ Create an ansible collection deprecated
PulpAnsibleClient::ContentCollectionDeprecationsApi list GET /pulp/api/v3/content/ansible/collection_deprecations/ List ansible collection deprecateds
PulpAnsibleClient::ContentCollectionDeprecationsApi read GET ansible_ansible_collection_deprecated_href Inspect an ansible collection deprecated
PulpAnsibleClient::ContentCollectionSignaturesApi create POST /pulp/api/v3/content/ansible/collection_signatures/ Create a collection version signature
PulpAnsibleClient::ContentCollectionSignaturesApi list GET /pulp/api/v3/content/ansible/collection_signatures/ List collection version signatures
PulpAnsibleClient::ContentCollectionSignaturesApi read GET ansible_collection_version_signature_href Inspect a collection version signature
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::PulpAnsibleApiV2CollectionsVersionsApi get GET /pulp_ansible/galaxy/path/api/v2/collections/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleApiV3Api read GET /pulp_ansible/galaxy/path/api/v3/
PulpAnsibleClient::PulpAnsibleApiV3ArtifactsCollectionsApi get GET /pulp_ansible/galaxy/path/api/v3/artifacts/collections/path/filename
PulpAnsibleClient::PulpAnsibleApiV3CollectionVersionsAllApi list GET /pulp_ansible/galaxy/path/api/v3/collection_versions/all/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi delete DELETE /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi list GET /pulp_ansible/galaxy/path/api/v3/collections/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi read GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi update PATCH /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsAllApi list GET /pulp_ansible/galaxy/path/api/v3/collections/all/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi delete DELETE /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi list GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi read GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsDocsBlobApi read GET /pulp_ansible/galaxy/path/api/v3/collections/namespace/name/versions/version/docs-blob/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleClientConfigurationApi get GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/client-configuration/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsApi read GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi list GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/all-collections/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsAllVersionsApi list GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/all-versions/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsArtifactsApi download GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/artifacts/filename
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexApi delete DELETE /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexApi list GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexApi read GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexApi update PATCH /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsApi delete DELETE /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsApi list GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsApi read GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi read GET /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/version/docs-blob/
PulpAnsibleClient::PulpAnsibleArtifactsCollectionsV3Api create POST /pulp_ansible/galaxy/path/api/v3/artifacts/collections/ Upload a collection
PulpAnsibleClient::PulpAnsibleArtifactsCollectionsV3Api create_0 POST /pulp_ansible/galaxy/path/api/v3/plugin/ansible/content/distro_base_path/collections/artifacts/ Upload a collection
PulpAnsibleClient::PulpAnsibleArtifactsCollectionsV3Api create_1 POST /pulp_ansible/galaxy/default/api/v3/artifacts/collections/ Upload a collection
PulpAnsibleClient::PulpAnsibleArtifactsCollectionsV3Api create_2 POST /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/artifacts/ Upload a collection
PulpAnsibleClient::PulpAnsibleDefaultApiApi get GET /pulp_ansible/galaxy/default/api/
PulpAnsibleClient::PulpAnsibleDefaultApiV3Api read GET /pulp_ansible/galaxy/default/api/v3/
PulpAnsibleClient::PulpAnsibleDefaultApiV3ArtifactsCollectionsApi get GET /pulp_ansible/galaxy/default/api/v3/artifacts/collections/path/filename
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionVersionsAllApi list GET /pulp_ansible/galaxy/default/api/v3/collection_versions/all/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsApi delete DELETE /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsApi list GET /pulp_ansible/galaxy/default/api/v3/collections/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsApi read GET /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsApi update PATCH /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsAllApi list GET /pulp_ansible/galaxy/default/api/v3/collections/all/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsApi delete DELETE /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsApi list GET /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/versions/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsApi read GET /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi read GET /pulp_ansible/galaxy/default/api/v3/collections/namespace/name/versions/version/docs-blob/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi get GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/client-configuration/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi read GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllCollectionsApi list GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/all-collections/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllVersionsApi list GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/all-versions/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi download GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/artifacts/filename
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi delete DELETE /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi list GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi read GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi update PATCH /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi delete DELETE /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi list GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi read GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/version/
PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi read GET /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/distro_base_path/collections/index/namespace/name/versions/version/docs-blob/
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::RemotesGitApi create POST /pulp/api/v3/remotes/ansible/git/ Create a git remote
PulpAnsibleClient::RemotesGitApi delete DELETE ansible_git_remote_href Delete a git remote
PulpAnsibleClient::RemotesGitApi list GET /pulp/api/v3/remotes/ansible/git/ List git remotes
PulpAnsibleClient::RemotesGitApi partial_update PATCH ansible_git_remote_href Update a git remote
PulpAnsibleClient::RemotesGitApi read GET ansible_git_remote_href Inspect a git remote
PulpAnsibleClient::RemotesGitApi update PUT ansible_git_remote_href Update a git 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 rebuild_metadata POST ansible_ansible_repository_hrefrebuild_metadata/
PulpAnsibleClient::RepositoriesAnsibleApi sign POST ansible_ansible_repository_hrefsign/
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 rebuild_metadata POST ansible_ansible_repository_version_hrefrebuild_metadata/
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

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication