1. Docs
  2. Reference
  3. API
  4. pulumi_f5bigip
  5. sys

sys

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.

class pulumi_f5bigip.sys.BigIpLicense(resource_name, opts=None, command=None, registration_key=None, __props__=None, __name__=None, __opts__=None)

Create a BigIpLicense resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] command: Tmsh command to execute tmsh commands like install :param pulumi.Input[str] registration_key: A unique Key F5 provides for Licensing BIG-IP

command: pulumi.Output[str] = None

Tmsh command to execute tmsh commands like install

registration_key: pulumi.Output[str] = None

A unique Key F5 provides for Licensing BIG-IP

static get(resource_name, id, opts=None, command=None, registration_key=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • command (pulumi.Input[str]) – Tmsh command to execute tmsh commands like install

  • registration_key (pulumi.Input[str]) – A unique Key F5 provides for Licensing BIG-IP

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_f5bigip.sys.Dns(resource_name, opts=None, description=None, name_servers=None, number_of_dots=None, searches=None, __props__=None, __name__=None, __opts__=None)

sys.Dns Configures DNS server on F5 BIG-IP

import pulumi
import pulumi_f5bigip as f5bigip

dns1 = f5bigip.sys.Dns("dns1",
    description="/Common/DNS1",
    name_servers=["1.1.1.1"],
    number_of_dots=2,
    searches=["f5.com"])
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Provide description for your DNS server

  • name_servers (pulumi.Input[list]) – Name or IP address of the DNS server

  • number_of_dots (pulumi.Input[float]) – Configures the number of dots needed in a name before an initial absolute query will be made.

  • searches (pulumi.Input[list]) – Specify what domains you want to search

description: pulumi.Output[str] = None

Provide description for your DNS server

name_servers: pulumi.Output[list] = None

Name or IP address of the DNS server

number_of_dots: pulumi.Output[float] = None

Configures the number of dots needed in a name before an initial absolute query will be made.

searches: pulumi.Output[list] = None

Specify what domains you want to search

static get(resource_name, id, opts=None, description=None, name_servers=None, number_of_dots=None, searches=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Provide description for your DNS server

  • name_servers (pulumi.Input[list]) – Name or IP address of the DNS server

  • number_of_dots (pulumi.Input[float]) – Configures the number of dots needed in a name before an initial absolute query will be made.

  • searches (pulumi.Input[list]) – Specify what domains you want to search

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_f5bigip.sys.IApp(resource_name, opts=None, description=None, devicegroup=None, execute_action=None, inherited_devicegroup=None, inherited_traffic_group=None, jsonfile=None, lists=None, metadatas=None, name=None, partition=None, strict_updates=None, tables=None, template=None, template_modified=None, template_prerequisite_errors=None, traffic_group=None, variables=None, __props__=None, __name__=None, __opts__=None)

sys.IApp resource helps you to deploy Application Services template that can be used to automate and orchestrate Layer 4-7 applications service deployments using F5 Network.

import pulumi
import pulumi_f5bigip as f5bigip

simplehttp = f5bigip.sys.IApp("simplehttp",
    name="simplehttp",
    jsonfile=(lambda path: open(path).read())("simplehttp.json"))

import pulumi

  • description - User defined description.

  • deviceGroup - The name of the device group that the application service is assigned to.

  • executeAction - Run the specified template action associated with the application.

  • inheritedDevicegroup- Read-only. Shows whether the application folder will automatically remain with the same device-group as its parent folder. Use ‘device-group default’ or ‘device-group non-default’ to set this.

  • inheritedTrafficGroup - Read-only. Shows whether the application folder will automatically remain with the same traffic-group as its parent folder. Use ‘traffic-group default’ or ‘traffic-group non-default’ to set this.

  • partition - Displays the administrative partition within which the application resides.

  • strictUpdates - Specifies whether configuration objects contained in the application may be directly modified, outside the context of the system’s application management interfaces.

  • template - The template defines the configuration for the application. This may be changed after the application has been created to move the application to a new template.

  • templateModified - Indicates that the application template used to deploy the application has been modified. The application should be updated to make use of the latest changes.

  • templatePrerequisiteErrors - Indicates any missing prerequisites associated with the template that defines this application.

  • trafficGroup - The name of the traffic group that the application service is assigned to.

  • lists - string values

  • metadata - User defined generic data for the application service. It is a name and value pair.

  • tables - Values provided like pool name, nodes etc.

  • variables - Name, values, encrypted or not

Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Address of the Iapp which needs to be Iappensed

  • devicegroup (pulumi.Input[str]) – BIG-IP password

  • execute_action (pulumi.Input[str]) – BIG-IP password

  • inherited_devicegroup (pulumi.Input[str]) – BIG-IP password

  • inherited_traffic_group (pulumi.Input[str]) – BIG-IP password

  • jsonfile (pulumi.Input[str]) – Refer to the Json file which will be deployed on F5 BIG-IP.

  • name (pulumi.Input[str]) – Name of the iApp.

  • partition (pulumi.Input[str]) – Address of the Iapp which needs to be Iappensed

  • strict_updates (pulumi.Input[str]) – BIG-IP password

  • template (pulumi.Input[str]) – BIG-IP password

  • template_modified (pulumi.Input[str]) – BIG-IP password

  • template_prerequisite_errors (pulumi.Input[str]) – BIG-IP password

  • traffic_group (pulumi.Input[str]) – BIG-IP password

The lists object supports the following:

  • encrypted (pulumi.Input[str])

  • value (pulumi.Input[str])

The metadatas object supports the following:

  • persists (pulumi.Input[str])

  • value (pulumi.Input[str])

The tables object supports the following:

  • columnNames (pulumi.Input[list])

  • encryptedColumns (pulumi.Input[str])

  • name (pulumi.Input[str]) - Name of the iApp.

  • rows (pulumi.Input[list])

    • rows (pulumi.Input[list])

The variables object supports the following:

  • encrypted (pulumi.Input[str])

  • name (pulumi.Input[str]) - Name of the iApp.

  • value (pulumi.Input[str])

description: pulumi.Output[str] = None

Address of the Iapp which needs to be Iappensed

devicegroup: pulumi.Output[str] = None

BIG-IP password

execute_action: pulumi.Output[str] = None

BIG-IP password

inherited_devicegroup: pulumi.Output[str] = None

BIG-IP password

inherited_traffic_group: pulumi.Output[str] = None

BIG-IP password

jsonfile: pulumi.Output[str] = None

Refer to the Json file which will be deployed on F5 BIG-IP.

name: pulumi.Output[str] = None

Name of the iApp.

partition: pulumi.Output[str] = None

Address of the Iapp which needs to be Iappensed

strict_updates: pulumi.Output[str] = None

BIG-IP password

template: pulumi.Output[str] = None

BIG-IP password

template_modified: pulumi.Output[str] = None

BIG-IP password

template_prerequisite_errors: pulumi.Output[str] = None

BIG-IP password

traffic_group: pulumi.Output[str] = None

BIG-IP password

static get(resource_name, id, opts=None, description=None, devicegroup=None, execute_action=None, inherited_devicegroup=None, inherited_traffic_group=None, jsonfile=None, lists=None, metadatas=None, name=None, partition=None, strict_updates=None, tables=None, template=None, template_modified=None, template_prerequisite_errors=None, traffic_group=None, variables=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Address of the Iapp which needs to be Iappensed

  • devicegroup (pulumi.Input[str]) – BIG-IP password

  • execute_action (pulumi.Input[str]) – BIG-IP password

  • inherited_devicegroup (pulumi.Input[str]) – BIG-IP password

  • inherited_traffic_group (pulumi.Input[str]) – BIG-IP password

  • jsonfile (pulumi.Input[str]) – Refer to the Json file which will be deployed on F5 BIG-IP.

  • name (pulumi.Input[str]) – Name of the iApp.

  • partition (pulumi.Input[str]) – Address of the Iapp which needs to be Iappensed

  • strict_updates (pulumi.Input[str]) – BIG-IP password

  • template (pulumi.Input[str]) – BIG-IP password

  • template_modified (pulumi.Input[str]) – BIG-IP password

  • template_prerequisite_errors (pulumi.Input[str]) – BIG-IP password

  • traffic_group (pulumi.Input[str]) – BIG-IP password

The lists object supports the following:

  • encrypted (pulumi.Input[str])

  • value (pulumi.Input[str])

The metadatas object supports the following:

  • persists (pulumi.Input[str])

  • value (pulumi.Input[str])

The tables object supports the following:

  • columnNames (pulumi.Input[list])

  • encryptedColumns (pulumi.Input[str])

  • name (pulumi.Input[str]) - Name of the iApp.

  • rows (pulumi.Input[list])

    • rows (pulumi.Input[list])

The variables object supports the following:

  • encrypted (pulumi.Input[str])

  • name (pulumi.Input[str]) - Name of the iApp.

  • value (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_f5bigip.sys.Ntp(resource_name, opts=None, description=None, servers=None, timezone=None, __props__=None, __name__=None, __opts__=None)

sys.Ntp provides details about a specific bigip

This resource is helpful when configuring NTP server on the BIG-IP.

import pulumi
import pulumi_f5bigip as f5bigip

ntp1 = f5bigip.sys.Ntp("ntp1",
    description="/Common/NTP1",
    servers=["time.facebook.com"],
    timezone="America/Los_Angeles")
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Name of the ntp Servers

  • servers (pulumi.Input[list]) – Adds NTP servers to or deletes NTP servers from the BIG-IP system.

  • timezone (pulumi.Input[str]) – Specifies the time zone that you want to use for the system time.

description: pulumi.Output[str] = None

Name of the ntp Servers

servers: pulumi.Output[list] = None

Adds NTP servers to or deletes NTP servers from the BIG-IP system.

timezone: pulumi.Output[str] = None

Specifies the time zone that you want to use for the system time.

static get(resource_name, id, opts=None, description=None, servers=None, timezone=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Name of the ntp Servers

  • servers (pulumi.Input[list]) – Adds NTP servers to or deletes NTP servers from the BIG-IP system.

  • timezone (pulumi.Input[str]) – Specifies the time zone that you want to use for the system time.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_f5bigip.sys.Provision(resource_name, opts=None, cpu_ratio=None, disk_ratio=None, full_path=None, level=None, memory_ratio=None, name=None, __props__=None, __name__=None, __opts__=None)

sys.Provision provides details bout how to enable “ilx”, “asm” “apm” resource on BIG-IP

import pulumi
import pulumi_f5bigip as f5bigip

test_provision = f5bigip.sys.Provision("test-provision",
    cpu_ratio=0,
    disk_ratio=0,
    full_path="asm",
    level="none",
    memory_ratio=0,
    name="TEST_ASM_PROVISION_NAME")
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cpu_ratio (pulumi.Input[float]) – cpu Ratio

  • disk_ratio (pulumi.Input[float]) – disk Ratio

  • full_path (pulumi.Input[str]) – path

  • level (pulumi.Input[str]) – what level nominal or dedicated

  • memory_ratio (pulumi.Input[float]) – memory Ratio

  • name (pulumi.Input[str]) – Name of the module to be provisioned

cpu_ratio: pulumi.Output[float] = None

cpu Ratio

disk_ratio: pulumi.Output[float] = None

disk Ratio

full_path: pulumi.Output[str] = None

path

level: pulumi.Output[str] = None

what level nominal or dedicated

memory_ratio: pulumi.Output[float] = None

memory Ratio

name: pulumi.Output[str] = None

Name of the module to be provisioned

static get(resource_name, id, opts=None, cpu_ratio=None, disk_ratio=None, full_path=None, level=None, memory_ratio=None, name=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cpu_ratio (pulumi.Input[float]) – cpu Ratio

  • disk_ratio (pulumi.Input[float]) – disk Ratio

  • full_path (pulumi.Input[str]) – path

  • level (pulumi.Input[str]) – what level nominal or dedicated

  • memory_ratio (pulumi.Input[float]) – memory Ratio

  • name (pulumi.Input[str]) – Name of the module to be provisioned

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_f5bigip.sys.Snmp(resource_name, opts=None, allowedaddresses=None, sys_contact=None, sys_location=None, __props__=None, __name__=None, __opts__=None)

sys.Snmp provides details bout how to enable “ilx”, “asm” “apm” resource on BIG-IP

import pulumi
import pulumi_f5bigip as f5bigip

snmp = f5bigip.sys.Snmp("snmp",
    allowedaddresses=["202.10.10.2"],
    sys_contact=" NetOPsAdmin s.shitole@f5.com",
    sys_location="SeattleHQ")
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allowedaddresses (pulumi.Input[list]) – Configures hosts or networks from which snmpd can accept traffic. Entries go directly into hosts.allow.

  • sys_contact (pulumi.Input[str]) – Specifies the contact information for the system administrator.

  • sys_location (pulumi.Input[str]) – Describes the system’s physical location.

allowedaddresses: pulumi.Output[list] = None

Configures hosts or networks from which snmpd can accept traffic. Entries go directly into hosts.allow.

sys_contact: pulumi.Output[str] = None

Specifies the contact information for the system administrator.

sys_location: pulumi.Output[str] = None

Describes the system’s physical location.

static get(resource_name, id, opts=None, allowedaddresses=None, sys_contact=None, sys_location=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allowedaddresses (pulumi.Input[list]) – Configures hosts or networks from which snmpd can accept traffic. Entries go directly into hosts.allow.

  • sys_contact (pulumi.Input[str]) – Specifies the contact information for the system administrator.

  • sys_location (pulumi.Input[str]) – Describes the system’s physical location.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_f5bigip.sys.SnmpTraps(resource_name, opts=None, auth_passwordencrypted=None, auth_protocol=None, community=None, description=None, engine_id=None, host=None, name=None, port=None, privacy_password=None, privacy_password_encrypted=None, privacy_protocol=None, security_level=None, security_name=None, version=None, __props__=None, __name__=None, __opts__=None)

sys.SnmpTraps provides details bout how to enable snmp_traps resource on BIG-IP

import pulumi
import pulumi_f5bigip as f5bigip

snmp_traps = f5bigip.sys.SnmpTraps("snmpTraps",
    community="f5community",
    description="Setup snmp traps",
    host="195.10.10.1",
    name="snmptraps",
    port=111)
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth_passwordencrypted (pulumi.Input[str]) – Encrypted password

  • auth_protocol (pulumi.Input[str]) – Specifies the protocol used to authenticate the user.

  • community (pulumi.Input[str]) – Specifies the community string used for this trap.

  • description (pulumi.Input[str]) – The port that the trap will be sent to.

  • engine_id (pulumi.Input[str]) – Specifies the authoritative security engine for SNMPv3.

  • host (pulumi.Input[str]) – The host the trap will be sent to.

  • name (pulumi.Input[str]) – Name of the snmp trap.

  • port (pulumi.Input[float]) – User defined description.

  • privacy_password (pulumi.Input[str]) – Specifies the clear text password used to encrypt traffic. This field will not be displayed.

  • privacy_password_encrypted (pulumi.Input[str]) – Specifies the encrypted password used to encrypt traffic.

  • privacy_protocol (pulumi.Input[str]) – Specifies the protocol used to encrypt traffic.

  • security_level (pulumi.Input[str]) – Specifies whether or not traffic is encrypted and whether or not authentication is required.

  • security_name (pulumi.Input[str]) – Security name used in conjunction with SNMPv3.

  • version (pulumi.Input[str]) – SNMP version used for sending the trap.

auth_passwordencrypted: pulumi.Output[str] = None

Encrypted password

auth_protocol: pulumi.Output[str] = None

Specifies the protocol used to authenticate the user.

community: pulumi.Output[str] = None

Specifies the community string used for this trap.

description: pulumi.Output[str] = None

The port that the trap will be sent to.

engine_id: pulumi.Output[str] = None

Specifies the authoritative security engine for SNMPv3.

host: pulumi.Output[str] = None

The host the trap will be sent to.

name: pulumi.Output[str] = None

Name of the snmp trap.

port: pulumi.Output[float] = None

User defined description.

privacy_password: pulumi.Output[str] = None

Specifies the clear text password used to encrypt traffic. This field will not be displayed.

privacy_password_encrypted: pulumi.Output[str] = None

Specifies the encrypted password used to encrypt traffic.

privacy_protocol: pulumi.Output[str] = None

Specifies the protocol used to encrypt traffic.

security_level: pulumi.Output[str] = None

Specifies whether or not traffic is encrypted and whether or not authentication is required.

security_name: pulumi.Output[str] = None

Security name used in conjunction with SNMPv3.

version: pulumi.Output[str] = None

SNMP version used for sending the trap.

static get(resource_name, id, opts=None, auth_passwordencrypted=None, auth_protocol=None, community=None, description=None, engine_id=None, host=None, name=None, port=None, privacy_password=None, privacy_password_encrypted=None, privacy_protocol=None, security_level=None, security_name=None, version=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth_passwordencrypted (pulumi.Input[str]) – Encrypted password

  • auth_protocol (pulumi.Input[str]) – Specifies the protocol used to authenticate the user.

  • community (pulumi.Input[str]) – Specifies the community string used for this trap.

  • description (pulumi.Input[str]) – The port that the trap will be sent to.

  • engine_id (pulumi.Input[str]) – Specifies the authoritative security engine for SNMPv3.

  • host (pulumi.Input[str]) – The host the trap will be sent to.

  • name (pulumi.Input[str]) – Name of the snmp trap.

  • port (pulumi.Input[float]) – User defined description.

  • privacy_password (pulumi.Input[str]) – Specifies the clear text password used to encrypt traffic. This field will not be displayed.

  • privacy_password_encrypted (pulumi.Input[str]) – Specifies the encrypted password used to encrypt traffic.

  • privacy_protocol (pulumi.Input[str]) – Specifies the protocol used to encrypt traffic.

  • security_level (pulumi.Input[str]) – Specifies whether or not traffic is encrypted and whether or not authentication is required.

  • security_name (pulumi.Input[str]) – Security name used in conjunction with SNMPv3.

  • version (pulumi.Input[str]) – SNMP version used for sending the trap.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str