An idiomatic C++ client library for theOS Config API, a service for patch management, patch compliance, and configuration management on VM instances.
While this library isGA, please note Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/osconfig/quickstart/directory, which should give you a taste of the OS Config API C++ client library API.
#include "google/cloud/osconfig/v1/os_config_client.h"
#include "google/cloud/project.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
namespace osconfig = ::google::cloud::osconfig_v1;
auto client = osconfig::OsConfigServiceClient(
osconfig::MakeOsConfigServiceConnection());
auto const project = google::cloud::Project(argv[1]);
for (auto p : client.ListPatchJobs(project.FullName())) {
if (!p) throw std::move(p).status();
std::cout << p->DebugString() << "\n";
}
return 0;
} catch (google::cloud::Status const& status) {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
Main classes
This library offers multiple*Clientclasses, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the*Clientclasses when testing your application.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the OS Config API C++ client library, which is used for managing patches, patch compliance, and configurations on virtual machine instances.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the OS Config API C++ client library is 2.37.0-rc, with links provided for this and many prior versions down to version 2.11.0.\u003c/p\u003e\n"],["\u003cp\u003eThe library contains multiple \u003ccode\u003e*Client\u003c/code\u003e classes, such as \u003ccode\u003eAgentEndpointServiceClient\u003c/code\u003e, \u003ccode\u003eOsConfigServiceClient\u003c/code\u003e, and \u003ccode\u003eOsConfigZonalServiceClient\u003c/code\u003e, that expose all the remote procedure calls (RPCs) for a service.\u003c/p\u003e\n"],["\u003cp\u003eWhile the OS Config API C++ client library is generally available (GA), it is important to know that the C++ client libraries do not follow Semantic Versioning.\u003c/p\u003e\n"],["\u003cp\u003eThe webpage also contains links to pages that describe error handling, how to override the default endpoint and authentication credentials, how to override the retry, backoff, and idempotency policies, and the relevant environment variables.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/osconfig/latest)\n- [2.41.0](/cpp/docs/reference/osconfig/2.41.0)\n- [2.40.0](/cpp/docs/reference/osconfig/2.40.0)\n- [2.39.0](/cpp/docs/reference/osconfig/2.39.0)\n- [2.38.0](/cpp/docs/reference/osconfig/2.38.0)\n- [2.37.0](/cpp/docs/reference/osconfig/2.37.0)\n- [2.36.0](/cpp/docs/reference/osconfig/2.36.0)\n- [2.35.0](/cpp/docs/reference/osconfig/2.35.0)\n- [2.34.0](/cpp/docs/reference/osconfig/2.34.0)\n- [2.33.0](/cpp/docs/reference/osconfig/2.33.0)\n- [2.32.0](/cpp/docs/reference/osconfig/2.32.0)\n- [2.31.0](/cpp/docs/reference/osconfig/2.31.0)\n- [2.30.0](/cpp/docs/reference/osconfig/2.30.0)\n- [2.29.0](/cpp/docs/reference/osconfig/2.29.0)\n- [2.28.0](/cpp/docs/reference/osconfig/2.28.0)\n- [2.27.0](/cpp/docs/reference/osconfig/2.27.0)\n- [2.26.0](/cpp/docs/reference/osconfig/2.26.0)\n- [2.25.1](/cpp/docs/reference/osconfig/2.25.1)\n- [2.24.0](/cpp/docs/reference/osconfig/2.24.0)\n- [2.23.0](/cpp/docs/reference/osconfig/2.23.0)\n- [2.22.1](/cpp/docs/reference/osconfig/2.22.1)\n- [2.21.0](/cpp/docs/reference/osconfig/2.21.0)\n- [2.20.0](/cpp/docs/reference/osconfig/2.20.0)\n- [2.19.0](/cpp/docs/reference/osconfig/2.19.0)\n- [2.18.0](/cpp/docs/reference/osconfig/2.18.0)\n- [2.17.0](/cpp/docs/reference/osconfig/2.17.0)\n- [2.16.0](/cpp/docs/reference/osconfig/2.16.0)\n- [2.15.1](/cpp/docs/reference/osconfig/2.15.1)\n- [2.14.0](/cpp/docs/reference/osconfig/2.14.0)\n- [2.13.0](/cpp/docs/reference/osconfig/2.13.0)\n- [2.12.0](/cpp/docs/reference/osconfig/2.12.0)\n- [2.11.0](/cpp/docs/reference/osconfig/2.11.0) \n\nOS Config API C++ Client Library\n================================\n\nAn idiomatic C++ client library for the [OS Config API](https://cloud.google.com/compute/docs/os-configuration-management), a service for patch management, patch compliance, and configuration management on VM instances.\n\nWhile this library is **GA** , please note Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/osconfig/quickstart/` directory, which should give you a taste of the OS Config API C++ client library API. \n\n #include \"google/cloud/osconfig/v1/os_config_client.h\"\n #include \"google/cloud/project.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 2) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id\\n\";\n return 1;\n }\n\n namespace osconfig = ::google::cloud::osconfig_v1;\n auto client = osconfig::OsConfigServiceClient(\n osconfig::MakeOsConfigServiceConnection());\n\n auto const project = google::cloud::Project(argv[1]);\n for (auto p : client.ListPatchJobs(project.FullName())) {\n if (!p) throw std::move(p).status();\n std::cout \u003c\u003c p-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThis library offers multiple `*Client` classes, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.\n\nThe library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the `*Client` classes when testing your application.\n\n- [`osconfig_agentendpoint_v1::AgentEndpointServiceClient`](/cpp/docs/reference/osconfig/latest/classgoogle_1_1cloud_1_1osconfig__agentendpoint__v1_1_1AgentEndpointServiceClient)\n- [`osconfig_v1::OsConfigServiceClient`](/cpp/docs/reference/osconfig/latest/classgoogle_1_1cloud_1_1osconfig__v1_1_1OsConfigServiceClient)\n- [`osconfig_v1::OsConfigZonalServiceClient`](/cpp/docs/reference/osconfig/latest/classgoogle_1_1cloud_1_1osconfig__v1_1_1OsConfigZonalServiceClient)\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/osconfig/latest/osconfig-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/osconfig/latest/osconfig-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/osconfig/latest/osconfig-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/osconfig/latest/osconfig-env) - describes environment variables that can configure the behavior of the library."]]