1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsOperatingSystems
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getIsOperatingSystems

Explore with Pulumi AI

Retrieve information of an existing IBM Cloud Infrastructure Operating Systems as a read only data source. For more information, about supported Operating System, see Images.

Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

provider.tf

import * as pulumi from "@pulumi/pulumi";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}
Copy
{}
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = ibm.getIsOperatingSystems({});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_operating_systems()
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIsOperatingSystems(ctx, &ibm.GetIsOperatingSystemsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsOperatingSystems.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsOperatingSystemsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = IbmFunctions.getIsOperatingSystems();

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsOperatingSystems
      arguments: {}
Copy

Using getIsOperatingSystems

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIsOperatingSystems(args: GetIsOperatingSystemsArgs, opts?: InvokeOptions): Promise<GetIsOperatingSystemsResult>
function getIsOperatingSystemsOutput(args: GetIsOperatingSystemsOutputArgs, opts?: InvokeOptions): Output<GetIsOperatingSystemsResult>
Copy
def get_is_operating_systems(id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetIsOperatingSystemsResult
def get_is_operating_systems_output(id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetIsOperatingSystemsResult]
Copy
func GetIsOperatingSystems(ctx *Context, args *GetIsOperatingSystemsArgs, opts ...InvokeOption) (*GetIsOperatingSystemsResult, error)
func GetIsOperatingSystemsOutput(ctx *Context, args *GetIsOperatingSystemsOutputArgs, opts ...InvokeOption) GetIsOperatingSystemsResultOutput
Copy

> Note: This function is named GetIsOperatingSystems in the Go SDK.

public static class GetIsOperatingSystems 
{
    public static Task<GetIsOperatingSystemsResult> InvokeAsync(GetIsOperatingSystemsArgs args, InvokeOptions? opts = null)
    public static Output<GetIsOperatingSystemsResult> Invoke(GetIsOperatingSystemsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsOperatingSystemsResult> getIsOperatingSystems(GetIsOperatingSystemsArgs args, InvokeOptions options)
public static Output<GetIsOperatingSystemsResult> getIsOperatingSystems(GetIsOperatingSystemsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsOperatingSystems:getIsOperatingSystems
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Id string
id String
id string
id str
id String

getIsOperatingSystems Result

The following output properties are available:

Id string
OperatingSystems List<GetIsOperatingSystemsOperatingSystem>
(List) List of all Operating Systems in the IBM Cloud Infrastructure region.
Id string
OperatingSystems []GetIsOperatingSystemsOperatingSystem
(List) List of all Operating Systems in the IBM Cloud Infrastructure region.
id String
operatingSystems List<GetIsOperatingSystemsOperatingSystem>
(List) List of all Operating Systems in the IBM Cloud Infrastructure region.
id string
operatingSystems GetIsOperatingSystemsOperatingSystem[]
(List) List of all Operating Systems in the IBM Cloud Infrastructure region.
id str
operating_systems Sequence[GetIsOperatingSystemsOperatingSystem]
(List) List of all Operating Systems in the IBM Cloud Infrastructure region.
id String
operatingSystems List<Property Map>
(List) List of all Operating Systems in the IBM Cloud Infrastructure region.

Supporting Types

GetIsOperatingSystemsOperatingSystem

AllowUserImageCreation This property is required. bool
(String) Users may create new images with this operating system.
Architecture This property is required. string
(String) The Operating System architecture.
DedicatedHostOnly This property is required. bool
(String) Images with this Operating System can only be used on dedicated hosts or dedicated host groups.
DisplayName This property is required. string
(String) A unique, display-friendly name for the Operating System.
Family This property is required. string
(String) The name of the software family this Operating System belongs to.
Href This property is required. string
(String) The URL for this Operating System.
Name This property is required. string
(String) The globally unique name for this Operating System.
UserDataFormat This property is required. string
(String) The user data format for this image.
Vendor This property is required. string
(String) The vendor of the Operating System.
Version This property is required. string
(String) The major release version of this Operating System.
AllowUserImageCreation This property is required. bool
(String) Users may create new images with this operating system.
Architecture This property is required. string
(String) The Operating System architecture.
DedicatedHostOnly This property is required. bool
(String) Images with this Operating System can only be used on dedicated hosts or dedicated host groups.
DisplayName This property is required. string
(String) A unique, display-friendly name for the Operating System.
Family This property is required. string
(String) The name of the software family this Operating System belongs to.
Href This property is required. string
(String) The URL for this Operating System.
Name This property is required. string
(String) The globally unique name for this Operating System.
UserDataFormat This property is required. string
(String) The user data format for this image.
Vendor This property is required. string
(String) The vendor of the Operating System.
Version This property is required. string
(String) The major release version of this Operating System.
allowUserImageCreation This property is required. Boolean
(String) Users may create new images with this operating system.
architecture This property is required. String
(String) The Operating System architecture.
dedicatedHostOnly This property is required. Boolean
(String) Images with this Operating System can only be used on dedicated hosts or dedicated host groups.
displayName This property is required. String
(String) A unique, display-friendly name for the Operating System.
family This property is required. String
(String) The name of the software family this Operating System belongs to.
href This property is required. String
(String) The URL for this Operating System.
name This property is required. String
(String) The globally unique name for this Operating System.
userDataFormat This property is required. String
(String) The user data format for this image.
vendor This property is required. String
(String) The vendor of the Operating System.
version This property is required. String
(String) The major release version of this Operating System.
allowUserImageCreation This property is required. boolean
(String) Users may create new images with this operating system.
architecture This property is required. string
(String) The Operating System architecture.
dedicatedHostOnly This property is required. boolean
(String) Images with this Operating System can only be used on dedicated hosts or dedicated host groups.
displayName This property is required. string
(String) A unique, display-friendly name for the Operating System.
family This property is required. string
(String) The name of the software family this Operating System belongs to.
href This property is required. string
(String) The URL for this Operating System.
name This property is required. string
(String) The globally unique name for this Operating System.
userDataFormat This property is required. string
(String) The user data format for this image.
vendor This property is required. string
(String) The vendor of the Operating System.
version This property is required. string
(String) The major release version of this Operating System.
allow_user_image_creation This property is required. bool
(String) Users may create new images with this operating system.
architecture This property is required. str
(String) The Operating System architecture.
dedicated_host_only This property is required. bool
(String) Images with this Operating System can only be used on dedicated hosts or dedicated host groups.
display_name This property is required. str
(String) A unique, display-friendly name for the Operating System.
family This property is required. str
(String) The name of the software family this Operating System belongs to.
href This property is required. str
(String) The URL for this Operating System.
name This property is required. str
(String) The globally unique name for this Operating System.
user_data_format This property is required. str
(String) The user data format for this image.
vendor This property is required. str
(String) The vendor of the Operating System.
version This property is required. str
(String) The major release version of this Operating System.
allowUserImageCreation This property is required. Boolean
(String) Users may create new images with this operating system.
architecture This property is required. String
(String) The Operating System architecture.
dedicatedHostOnly This property is required. Boolean
(String) Images with this Operating System can only be used on dedicated hosts or dedicated host groups.
displayName This property is required. String
(String) A unique, display-friendly name for the Operating System.
family This property is required. String
(String) The name of the software family this Operating System belongs to.
href This property is required. String
(String) The URL for this Operating System.
name This property is required. String
(String) The globally unique name for this Operating System.
userDataFormat This property is required. String
(String) The user data format for this image.
vendor This property is required. String
(String) The vendor of the Operating System.
version This property is required. String
(String) The major release version of this Operating System.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.