Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsOperatingSystem
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsOperatingSystem

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information of an existing Operating System 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";

    import pulumi

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

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

    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) {
    }
}

    {}

    Example Usage

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

const example = ibm.getIsOperatingSystem({
    name: "centos-7-amd64",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_operating_system(name="centos-7-amd64")

    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.GetIsOperatingSystem(ctx, &ibm.GetIsOperatingSystemArgs{
			Name: "centos-7-amd64",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsOperatingSystem.Invoke(new()
    {
        Name = "centos-7-amd64",
    });

});

    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.GetIsOperatingSystemArgs;
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.getIsOperatingSystem(GetIsOperatingSystemArgs.builder()
            .name("centos-7-amd64")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsOperatingSystem
      arguments:
        name: centos-7-amd64

    Using getIsOperatingSystem

    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 getIsOperatingSystem(args: GetIsOperatingSystemArgs, opts?: InvokeOptions): Promise<GetIsOperatingSystemResult>
function getIsOperatingSystemOutput(args: GetIsOperatingSystemOutputArgs, opts?: InvokeOptions): Output<GetIsOperatingSystemResult>
    def get_is_operating_system(id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetIsOperatingSystemResult
def get_is_operating_system_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetIsOperatingSystemResult]
    func GetIsOperatingSystem(ctx *Context, args *GetIsOperatingSystemArgs, opts ...InvokeOption) (*GetIsOperatingSystemResult, error)
func GetIsOperatingSystemOutput(ctx *Context, args *GetIsOperatingSystemOutputArgs, opts ...InvokeOption) GetIsOperatingSystemResultOutput

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

    public static class GetIsOperatingSystem 
{
    public static Task<GetIsOperatingSystemResult> InvokeAsync(GetIsOperatingSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetIsOperatingSystemResult> Invoke(GetIsOperatingSystemInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsOperatingSystemResult> getIsOperatingSystem(GetIsOperatingSystemArgs args, InvokeOptions options)
public static Output<GetIsOperatingSystemResult> getIsOperatingSystem(GetIsOperatingSystemArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsOperatingSystem:getIsOperatingSystem
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The global unique name of an Operating System.
    Id string
    (String) The globally unique name of an Operating System.
    Name string
    The global unique name of an Operating System.
    Id string
    (String) The globally unique name of an Operating System.
    name String
    The global unique name of an Operating System.
    id String
    (String) The globally unique name of an Operating System.
    name string
    The global unique name of an Operating System.
    id string
    (String) The globally unique name of an Operating System.
    name str
    The global unique name of an Operating System.
    id str
    (String) The globally unique name of an Operating System.
    name String
    The global unique name of an Operating System.
    id String
    (String) The globally unique name of an Operating System.

    getIsOperatingSystem Result

    The following output properties are available:

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm