DeviceGroup
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
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;
class MyStack : Stack
{
public MyStack()
{
var myNewDevicegroup = new F5BigIP.CM.DeviceGroup("myNewDevicegroup", new F5BigIP.CM.DeviceGroupArgs
{
AutoSync = "enabled",
Devices =
{
new F5BigIP.CM.Inputs.DeviceGroupDeviceArgs
{
Name = "bigip1.cisco.com",
},
new F5BigIP.CM.Inputs.DeviceGroupDeviceArgs
{
Name = "bigip200.f5.com",
},
},
FullLoadOnSync = "true",
Name = "sanjose_devicegroup",
Type = "sync-only",
});
}
}
Coming soon!
import pulumi
import pulumi_f5bigip as f5bigip
my_new_devicegroup = f5bigip.cm.DeviceGroup("myNewDevicegroup",
auto_sync="enabled",
devices=[
{
"name": "bigip1.cisco.com",
},
{
"name": "bigip200.f5.com",
},
],
full_load_on_sync="true",
name="sanjose_devicegroup",
type="sync-only")import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";
const myNewDevicegroup = new f5bigip.cm.DeviceGroup("my_new_devicegroup", {
autoSync: "enabled",
devices: [
{
name: "bigip1.cisco.com",
},
{
name: "bigip200.f5.com",
},
],
fullLoadOnSync: "true",
name: "sanjose_devicegroup",
type: "sync-only",
});Create a DeviceGroup Resource
new DeviceGroup(name: string, args?: DeviceGroupArgs, opts?: CustomResourceOptions);def DeviceGroup(resource_name, opts=None, auto_sync=None, description=None, devices=None, full_load_on_sync=None, incremental_config=None, name=None, network_failover=None, partition=None, save_on_auto_sync=None, type=None, __props__=None);func NewDeviceGroup(ctx *Context, name string, args *DeviceGroupArgs, opts ...ResourceOption) (*DeviceGroup, error)public DeviceGroup(string name, DeviceGroupArgs? args = null, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args DeviceGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DeviceGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeviceGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
DeviceGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The DeviceGroup resource accepts the following input properties:
- Auto
Sync string Specifies if the device-group will automatically sync configuration data to its members
- Description string
Description of Device group
- Devices
List<Pulumi.
F5Big IP. CM. Inputs. Device Group Device Args> Name of the device to be included in device group, this need to be configured before using devicegroup resource
- Full
Load stringOn Sync Specifies if the device-group will perform a full-load upon sync
- Incremental
Config int Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- Name string
Is the name of the device Group
- Network
Failover string Specifies if the device-group will use a network connection for failover
- Partition string
Device administrative partition
- Save
On stringAuto Sync Specifies whether the configuration should be saved upon auto-sync.
- Type string
Specifies if the device-group will be used for failover or resource syncing
- Auto
Sync string Specifies if the device-group will automatically sync configuration data to its members
- Description string
Description of Device group
- Devices
[]Device
Group Device Name of the device to be included in device group, this need to be configured before using devicegroup resource
- Full
Load stringOn Sync Specifies if the device-group will perform a full-load upon sync
- Incremental
Config int Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- Name string
Is the name of the device Group
- Network
Failover string Specifies if the device-group will use a network connection for failover
- Partition string
Device administrative partition
- Save
On stringAuto Sync Specifies whether the configuration should be saved upon auto-sync.
- Type string
Specifies if the device-group will be used for failover or resource syncing
- auto
Sync string Specifies if the device-group will automatically sync configuration data to its members
- description string
Description of Device group
- devices
Device
Group Device[] Name of the device to be included in device group, this need to be configured before using devicegroup resource
- full
Load stringOn Sync Specifies if the device-group will perform a full-load upon sync
- incremental
Config number Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- name string
Is the name of the device Group
- network
Failover string Specifies if the device-group will use a network connection for failover
- partition string
Device administrative partition
- save
On stringAuto Sync Specifies whether the configuration should be saved upon auto-sync.
- type string
Specifies if the device-group will be used for failover or resource syncing
- auto_
sync str Specifies if the device-group will automatically sync configuration data to its members
- description str
Description of Device group
- devices
List[Device
Group Device] Name of the device to be included in device group, this need to be configured before using devicegroup resource
- full_
load_ stron_ sync Specifies if the device-group will perform a full-load upon sync
- incremental_
config float Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- name str
Is the name of the device Group
- network_
failover str Specifies if the device-group will use a network connection for failover
- partition str
Device administrative partition
- save_
on_ strauto_ sync Specifies whether the configuration should be saved upon auto-sync.
- type str
Specifies if the device-group will be used for failover or resource syncing
Outputs
All input properties are implicitly available as output properties. Additionally, the DeviceGroup resource produces the following output properties:
Look up an Existing DeviceGroup Resource
Get an existing DeviceGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DeviceGroupState, opts?: CustomResourceOptions): DeviceGroupstatic get(resource_name, id, opts=None, auto_sync=None, description=None, devices=None, full_load_on_sync=None, incremental_config=None, name=None, network_failover=None, partition=None, save_on_auto_sync=None, type=None, __props__=None);func GetDeviceGroup(ctx *Context, name string, id IDInput, state *DeviceGroupState, opts ...ResourceOption) (*DeviceGroup, error)public static DeviceGroup Get(string name, Input<string> id, DeviceGroupState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Auto
Sync string Specifies if the device-group will automatically sync configuration data to its members
- Description string
Description of Device group
- Devices
List<Pulumi.
F5Big IP. CM. Inputs. Device Group Device Args> Name of the device to be included in device group, this need to be configured before using devicegroup resource
- Full
Load stringOn Sync Specifies if the device-group will perform a full-load upon sync
- Incremental
Config int Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- Name string
Is the name of the device Group
- Network
Failover string Specifies if the device-group will use a network connection for failover
- Partition string
Device administrative partition
- Save
On stringAuto Sync Specifies whether the configuration should be saved upon auto-sync.
- Type string
Specifies if the device-group will be used for failover or resource syncing
- Auto
Sync string Specifies if the device-group will automatically sync configuration data to its members
- Description string
Description of Device group
- Devices
[]Device
Group Device Name of the device to be included in device group, this need to be configured before using devicegroup resource
- Full
Load stringOn Sync Specifies if the device-group will perform a full-load upon sync
- Incremental
Config int Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- Name string
Is the name of the device Group
- Network
Failover string Specifies if the device-group will use a network connection for failover
- Partition string
Device administrative partition
- Save
On stringAuto Sync Specifies whether the configuration should be saved upon auto-sync.
- Type string
Specifies if the device-group will be used for failover or resource syncing
- auto
Sync string Specifies if the device-group will automatically sync configuration data to its members
- description string
Description of Device group
- devices
Device
Group Device[] Name of the device to be included in device group, this need to be configured before using devicegroup resource
- full
Load stringOn Sync Specifies if the device-group will perform a full-load upon sync
- incremental
Config number Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- name string
Is the name of the device Group
- network
Failover string Specifies if the device-group will use a network connection for failover
- partition string
Device administrative partition
- save
On stringAuto Sync Specifies whether the configuration should be saved upon auto-sync.
- type string
Specifies if the device-group will be used for failover or resource syncing
- auto_
sync str Specifies if the device-group will automatically sync configuration data to its members
- description str
Description of Device group
- devices
List[Device
Group Device] Name of the device to be included in device group, this need to be configured before using devicegroup resource
- full_
load_ stron_ sync Specifies if the device-group will perform a full-load upon sync
- incremental_
config float Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
- name str
Is the name of the device Group
- network_
failover str Specifies if the device-group will use a network connection for failover
- partition str
Device administrative partition
- save_
on_ strauto_ sync Specifies whether the configuration should be saved upon auto-sync.
- type str
Specifies if the device-group will be used for failover or resource syncing
Supporting Types
DeviceGroupDevice
- Name string
Is the name of the device Group
- Set
Sync boolLeader
- Name string
Is the name of the device Group
- Set
Sync boolLeader
- name string
Is the name of the device Group
- set
Sync booleanLeader
- name str
Is the name of the device Group
- set
Sync boolLeader
Package Details
- Repository
- https://github.com/pulumi/pulumi-f5bigip
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
bigipTerraform Provider.