Blame - docs/dyn/osconfig_v1beta.projects.zones.instances.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#lookupEffectiveGuestPolicy">lookupEffectiveGuestPolicy(instance, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

83

<h3>Method Details</h3>

84

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<code class="details" id="close">close()</code>

86

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

90

<code class="details" id="lookupEffectiveGuestPolicy">lookupEffectiveGuestPolicy(instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<pre>Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

92

93

Args:

94

instance: string, Required. The VM instance whose policies are being looked up. (required)

95

body: object, The request body.

96

The object takes the form of:

97

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

98

{ # A request message for getting the effective guest policy assigned to the instance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

99

"osShortName": "A String", # Short name of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

100

"osArchitecture": "A String", # Architecture of OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

101

"osVersion": "A String", # Version of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that VM instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

102

}

103

104

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

111

112

{ # The effective guest policy that applies to a VM instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

113

"packages": [ # List of package configurations assigned to the VM instance.

114

{ # A guest policy package including its source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

115

"source": "A String", # Name of the guest policy providing this config.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

116

"package": { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` # A software package to configure on the VM instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

117

"manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY.

118

"name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

119

"desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

120

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

121

},

122

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

123

"softwareRecipes": [ # List of recipes assigned to the VM instance.

124

{ # A guest policy recipe including its source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

125

"source": "A String", # Name of the guest policy providing this config.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

"softwareRecipe": { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. # A software recipe to configure on the VM instance.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

127

"updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

128

{ # An action that can be taken as part of installing or updating a recipe.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

129

"rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility.

130

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

131

},

132

"fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance.

133

"overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false.

134

"permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

135

"destination": "A String", # Required. The absolute path on the instance to put the file.

136

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

137

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

138

"scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

139

"script": "A String", # Required. The shell script to be executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

140

"allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]

141

42,

142

],

143

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

144

},

145

"archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory.

146

"destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows.

147

"type": "A String", # Required. The type of the archive to extract.

148

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

149

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

150

"fileExec": { # Executes an artifact or local file. # Executes an artifact or local file.

151

"localPath": "A String", # The absolute path of the file on the local filesystem.

152

"artifactId": "A String", # The id of the relevant artifact in the recipe.

153

"args": [ # Arguments to be passed to the provided executable.

154

"A String",

155

],

156

"allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success.

157

42,

158

],

159

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

160

"msiInstallation": { # Installs an MSI file. # Installs an MSI file.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

161

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

162

"flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag).

163

"A String",

164

],

165

"allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]

166

42,

167

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

168

},

169

"dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg.

170

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

171

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

172

},

173

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

174

"name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

175

"installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.

176

{ # An action that can be taken as part of installing or updating a recipe.

177

"rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility.

178

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

179

},

180

"fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance.

181

"overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false.

182

"permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

183

"destination": "A String", # Required. The absolute path on the instance to put the file.

184

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

185

},

186

"scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell.

187

"script": "A String", # Required. The shell script to be executed.

188

"allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]

189

42,

190

],

191

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

192

},

193

"archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory.

194

"destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows.

195

"type": "A String", # Required. The type of the archive to extract.

196

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

197

},

198

"fileExec": { # Executes an artifact or local file. # Executes an artifact or local file.

199

"localPath": "A String", # The absolute path of the file on the local filesystem.

200

"artifactId": "A String", # The id of the relevant artifact in the recipe.

201

"args": [ # Arguments to be passed to the provided executable.

202

"A String",

203

],

204

"allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success.

42,

],

},

"msiInstallation": { # Installs an MSI file. # Installs an MSI file.

209

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

210

"flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag).

211

"A String",

212

],

213

"allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]

42,

],

},

"dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg.

218

"artifactId": "A String", # Required. The id of the relevant artifact in the recipe.

},

},

],

"version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

223

"artifacts": [ # Resources available to be used in the steps in the recipe.

224

{ # Specifies a resource to be used in the recipe.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

225

"gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

226

"generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

227

"bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

228

"object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`.

229

},

230

"remote": { # Specifies an artifact available via some URI. # A generic remote artifact.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

231

"uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

232

"checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

233

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

234

"id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

235

"allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

236

},

237

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

238

"desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

239

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

240

},

241

],

242

"packageRepositories": [ # List of package repository configurations assigned to the VM instance.

243

{ # A guest policy package repository including its source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

244

"source": "A String", # Name of the guest policy providing this config.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

245

"packageRepository": { # A package repository. # A software package repository to configure on the VM instance.

246

"goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository.

247

"name": "A String", # Required. The name of the repository.

248

"url": "A String", # Required. The url of the repository.

249

},

250

"yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository.

251

"id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts.

252

"displayName": "A String", # The display name of the repository.

253

"baseUrl": "A String", # Required. The location of the repository directory.

254

"gpgKeys": [ # URIs of GPG keys.

"A String",

],

},

"apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository.

259

"gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy.

260

"uri": "A String", # Required. URI for this repository.

261

"components": [ # Required. List of components for this repository. Must contain at least one item.

262

"A String",

263

],

264

"distribution": "A String", # Required. Distribution of this repository.

265

"archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB.

266

},

267

"zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository.

268

"gpgKeys": [ # URIs of GPG keys.

269

"A String",

270

],

271

"id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts.

272

"displayName": "A String", # The display name of the repository.

273

"baseUrl": "A String", # Required. The location of the repository directory.

274

},

275

},

Bu Sun Kim