1. Docs
  2. Reference
  3. API
  4. @pulumi/f5bigip
  5. cm

Module cm

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-f5bigip repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-f5bigip repo.

Resources

Others

Resources

Resource Device

class Device extends CustomResource

f5bigip.cm.Device provides details about a specific bigip

This resource is helpful when configuring the BIG-IP device in cluster or in HA mode.

Example Usage

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

const myNewDevice = new f5bigip.cm.Device("myNewDevice", {
    configsyncIp: "2.2.2.2",
    mirrorIp: "10.10.10.10",
    mirrorSecondaryIp: "11.11.11.11",
    name: "bigip300.f5.com",
});

constructor

new Device(name: string, args: DeviceArgs, opts?: pulumi.CustomResourceOptions)

Create a Device resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeviceState, opts?: pulumi.CustomResourceOptions): Device

Get an existing Device resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Device

Returns true if the given object is an instance of Device. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property configsyncIp

public configsyncIp: pulumi.Output<string>;

IP address used for config sync

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mirrorIp

public mirrorIp: pulumi.Output<string | undefined>;

IP address used for state mirroring

property mirrorSecondaryIp

public mirrorSecondaryIp: pulumi.Output<string | undefined>;

Secondary IP address used for state mirroring

property name

public name: pulumi.Output<string>;

Address of the Device which needs to be Deviceensed

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DeviceGroup

class DeviceGroup extends CustomResource

f5bigip.cm.DeviceGroup A device group is a collection of BIG-IP devices that are configured to securely synchronize their BIG-IP configuration data, and fail over when needed.

Example Usage

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

const myNewDevicegroup = new f5bigip.cm.DeviceGroup("myNewDevicegroup", {
    autoSync: "enabled",
    devices: [
        {
            name: "bigip1.cisco.com",
        },
        {
            name: "bigip200.f5.com",
        },
    ],
    fullLoadOnSync: "true",
    name: "sanjoseDevicegroup",
    type: "sync-only",
});

constructor

new DeviceGroup(name: string, args?: DeviceGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a DeviceGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeviceGroupState, opts?: pulumi.CustomResourceOptions): DeviceGroup

Get an existing DeviceGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DeviceGroup

Returns true if the given object is an instance of DeviceGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property autoSync

public autoSync: pulumi.Output<string | undefined>;

Specifies if the device-group will automatically sync configuration data to its members

property description

public description: pulumi.Output<string | undefined>;

Description of Device group

property devices

public devices: pulumi.Output<DeviceGroupDevice[] | undefined>;

Name of the device to be included in device group, this need to be configured before using devicegroup resource

property fullLoadOnSync

public fullLoadOnSync: pulumi.Output<string | undefined>;

Specifies if the device-group will perform a full-load upon sync

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property incrementalConfig

public incrementalConfig: pulumi.Output<number | undefined>;

Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.

property name

public name: pulumi.Output<string | undefined>;

Is the name of the device Group

property networkFailover

public networkFailover: pulumi.Output<string | undefined>;

Specifies if the device-group will use a network connection for failover

property partition

public partition: pulumi.Output<string | undefined>;

Device administrative partition

property saveOnAutoSync

public saveOnAutoSync: pulumi.Output<string | undefined>;

Specifies whether the configuration should be saved upon auto-sync.

property type

public type: pulumi.Output<string | undefined>;

Specifies if the device-group will be used for failover or resource syncing

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface DeviceArgs

interface DeviceArgs

The set of arguments for constructing a Device resource.

property configsyncIp

configsyncIp: pulumi.Input<string>;

IP address used for config sync

property mirrorIp

mirrorIp?: pulumi.Input<string>;

IP address used for state mirroring

property mirrorSecondaryIp

mirrorSecondaryIp?: pulumi.Input<string>;

Secondary IP address used for state mirroring

property name

name: pulumi.Input<string>;

Address of the Device which needs to be Deviceensed

interface DeviceGroupArgs

interface DeviceGroupArgs

The set of arguments for constructing a DeviceGroup resource.

property autoSync

autoSync?: pulumi.Input<string>;

Specifies if the device-group will automatically sync configuration data to its members

property description

description?: pulumi.Input<string>;

Description of Device group

property devices

devices?: pulumi.Input<pulumi.Input<DeviceGroupDevice>[]>;

Name of the device to be included in device group, this need to be configured before using devicegroup resource

property fullLoadOnSync

fullLoadOnSync?: pulumi.Input<string>;

Specifies if the device-group will perform a full-load upon sync

property incrementalConfig

incrementalConfig?: pulumi.Input<number>;

Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.

property name

name?: pulumi.Input<string>;

Is the name of the device Group

property networkFailover

networkFailover?: pulumi.Input<string>;

Specifies if the device-group will use a network connection for failover

property partition

partition?: pulumi.Input<string>;

Device administrative partition

property saveOnAutoSync

saveOnAutoSync?: pulumi.Input<string>;

Specifies whether the configuration should be saved upon auto-sync.

property type

type?: pulumi.Input<string>;

Specifies if the device-group will be used for failover or resource syncing

interface DeviceGroupState

interface DeviceGroupState

Input properties used for looking up and filtering DeviceGroup resources.

property autoSync

autoSync?: pulumi.Input<string>;

Specifies if the device-group will automatically sync configuration data to its members

property description

description?: pulumi.Input<string>;

Description of Device group

property devices

devices?: pulumi.Input<pulumi.Input<DeviceGroupDevice>[]>;

Name of the device to be included in device group, this need to be configured before using devicegroup resource

property fullLoadOnSync

fullLoadOnSync?: pulumi.Input<string>;

Specifies if the device-group will perform a full-load upon sync

property incrementalConfig

incrementalConfig?: pulumi.Input<number>;

Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.

property name

name?: pulumi.Input<string>;

Is the name of the device Group

property networkFailover

networkFailover?: pulumi.Input<string>;

Specifies if the device-group will use a network connection for failover

property partition

partition?: pulumi.Input<string>;

Device administrative partition

property saveOnAutoSync

saveOnAutoSync?: pulumi.Input<string>;

Specifies whether the configuration should be saved upon auto-sync.

property type

type?: pulumi.Input<string>;

Specifies if the device-group will be used for failover or resource syncing

interface DeviceState

interface DeviceState

Input properties used for looking up and filtering Device resources.

property configsyncIp

configsyncIp?: pulumi.Input<string>;

IP address used for config sync

property mirrorIp

mirrorIp?: pulumi.Input<string>;

IP address used for state mirroring

property mirrorSecondaryIp

mirrorSecondaryIp?: pulumi.Input<string>;

Secondary IP address used for state mirroring

property name

name?: pulumi.Input<string>;

Address of the Device which needs to be Deviceensed