- Itential Cloud
- Release Announcements
- Admin Portal
- Automation Service
- Getting Started
- Automation Service Guides
- Releases & Highlights
- Itential Automation Gateway 5 (IAG5)
- What's New
- Intro to IAG5
- Installation
- Scalable Designs
- Creating a Service
- Decorators
- Using IAG5
- Command References
- Config Variables
- FAQ & Support
- Itential Platform (2023.2)
- Orchestration Environments
- Admin Essentials
- API Documentation
- Studio
- Navigation & User Interface
- Automation Builder
- Intro to Automation Builder
- New Canvas Experience
- How to Create and Run Workflows on the Canvas
- How to Configure Tasks on the Canvas
- How to Modify Tasks on the Canvas
- How to Use Transitions and Task States on the Canvas
- Parallel Branching on the Canvas
- Troubleshooting Errors and Warnings on the New Canvas
- Keyboard Shortcuts for the Canvas
- How to Use Search in the New Canvas
- How to Use the Reference View
- Gen 1 Automation Builder Canvas
- Projects
- Forms
- JSON Forms
- Template Builder
- Command Templates
- Analytic Templates
- Task References
- Transformations
- Configuration Manager
- Integrations & Adapters
- Legacy & Custom
- Lifecycle Manager
- Operations Manager
- Using NSO with Itential Cloud
- Breaking Changes
- Broken References
- Data Path Property Renamed
- DryRun & View DryRun Manual Tasks Removed
- Help and Status API Endpoints Removed
- IAP Key Removed
- Integration API Routes Removed
- Job Variable Changes in Child Workflows
- IWAN Tasks Removed
- NSO Features Removed
- Merge Task Variables - Null vs. Undefined
- Operations Manager API Changes
- Removed Inline Images from Pre-built Automation README Files
- Reserved Method Output Name
- Seed Scripts Removed in Template Builder
- Service Manager UI Removed
- Workflow Engine API Routes Removed
- Itential Platform (2023.1)
- Orchestration Environments
- Admin Essentials
- API Documentation
- Automation Studio
- Navigation & User Interface
- Automation Builder in IAP
- Intro to Automation Builder
- Gen 1 Automation Builder
- New Canvas Experience in Automation Builder
- How to Create and Run Workflows on the Canvas
- How to Configure and Edit Tasks on the Canvas
- How to Use Transitions and Task States on the Canvas
- How to Use Search in the New Canvas
- How to Use the Reference View
- Parallel Branching on the Canvas
- Troubleshooting Errors and Warnings on the New Canvas
- Keyboard Shortcuts for the Canvas
- Forms
- JSON Forms
- Template Builder
- Analytic Templates
- Command Templates
- Task References
- Transformations
- Configuration Manager
- Integrations & Adapters
- Legacy & Custom
- Lifecycle Manager
- Operations Manager
- Using NSO with IAP
- Itential Cloud Use Case Walk-Throughs
- QuickStart Automation Use Cases
- Asset Reservation
- Itential Cloud Use Case Walk-Through - Port/VLAN Configuration (IOS) 2023.1
- Port/VLAN Configuration (IOS) - Overview
- Port/VLAN Configuration (IOS) - Device Configuration
- Port/VLAN Configuration (IOS) - Command Templates
- Port/VLAN Configuration (IOS) - JSON Form
- Port/VLAN Configuration (IOS) - Transformations
- Port/VLAN Configuration (IOS) - Pre-Built
- Port/VLAN Configuration (IOS) - Workflow
- Port/VLAN Configuration (IOS) - Operations Manager
- Port/VLAN Configuration (IOS) - Configuration Manager
- Port/VLAN Configuration (IOS) - Summary
- Itential Cloud Use Case Walk-Through - Port/VLAN Configuration (EOS) 2023.1
- Port/VLAN Configuration (EOS) - Overview
- Port/VLAN Configuration (EOS) - Device Configuration
- Port/VLAN Configuration (EOS) - Command Templates
- Port/VLAN Configuration (EOS) - JSON Form
- Port/VLAN Configuration (EOS) - Transformations
- Port/VLAN Configuration (EOS) - Pre-Built
- Port/VLAN Configuration (EOS) - Workflow
- Port/VLAN Configuration (EOS) - Operations Manager
- Port/VLAN Configuration (EOS) - Configuration Manager
- Port/VLAN Configuration (EOS) - Summary
- Itential Cloud Use Case Walk-Through - Create a Security Rule (Panorama) 2023.1
- Itential Cloud Use Case Walk-Through - Create Pool and Virtual Server (Big-IP) 2023.1
- Create Pool & Virtual Server (BIG-IP) - Overview
- Create Pool & Virtual Server (BIG-IP) - JSON Forms
- Create Pool & Virtual Server (BIG-IP) - Transformations
- Create Pool & Virtual Server (BIG-IP) - Workflow
- Create Pool & Virtual Server (BIG-IP) - Operations Manager
- Create Pool & Virtual Server (BIG-IP) - Summary (2023.1)
- Itential Cloud Use Case Walk-Through - Create and Update Change Request (ServiceNow)
- Create and Update Change Request (ServiceNow) - Overview
- Create and Update Change Request (ServiceNow) - Jinja2 Template
- Create and Update Change Request (ServiceNow) - JSON Form
- Create and Update Change Request (ServiceNow) - Transformation
- Create and Update Change Request (ServiceNow) - Workflow
- Create and Update Change Request (ServiceNow) - Operations Manager
- Create and Update Change Request (ServiceNow) - Summary
- Itential Cloud Use Case Walk-Through - Create and Update Incident (ServiceNow)
- Create and Update Incident (ServiceNow) - Overview
- Create and Update Incident (ServiceNow) - Configuration Manager
- Create and Update Incident (ServiceNow) - Jinja2 Templates
- Create and Update Incident (ServiceNow) - JSON Forms
- Create and Update Incident (ServiceNow) - Transformations
- Create and Update Incident (ServiceNow) - Workflow
- Create and Update Incident (ServiceNow) - Operations Manager
- Create and Update Incident (ServiceNow) - Summary
- Itential Cloud Use Case Walk-Through - Golden Configuration (IOS)
- Itential Cloud Use Case Walk-Through - Provision VPC & EC2 (AWS)
- Provision VPC and EC2 Instance (AWS) - Overview
- Provision VPC and EC2 Instance (AWS) - Transformation
- Provision VPC and EC2 Instance (AWS) - Pre-Built Workflows
- Provision VPC and EC2 Instance (AWS) - JSON Form
- Provision VPC and EC2 Instance (AWS) - Workflow
- Provision VPC and EC2 Instance (AWS) - Operations Manager
- Provision VPC and EC2 Instance (AWS) - Clean Up
- Provision VPC and EC2 Instance (AWS) - Summary
- Itential Cloud Use Case Walk-Through - Software Upgrade (IOS)
- Software Upgrade (IOS) - Overview
- Software Upgrade (IOS) - Device Configuration
- Software Upgrade (IOS) - Command Templates
- Software Upgrade (IOS) - JSON Form
- Software Upgrade (IOS) - Transformation
- Software Upgrade (IOS) - Workflow
- Software Upgrade (IOS) - Operations Manager
- Software Upgrade (IOS) - Configuration Manager
- Software Upgrade (IOS) - Summary
- Itential Cloud Use Case Walk-Through - Software Upgrade (EOS)
- Software Upgrade (EOS) - Overview
- Software Upgrade (EOS) - Device Configuration
- Software Upgrade (EOS) - Command Templates
- Software Upgrade (EOS) - JSON Form
- Software Upgrade (EOS) - Transformation
- Software Upgrade (EOS) - Workflow
- Software Upgrade (EOS) - Operations Manager
- Software Upgrade (EOS) - Configuration Manager
- Software Upgrade (EOS) - Summary
- Itential Cloud Use Case Walk-Through - API Compliance (AWS)
- Itential Cloud Use Case Walk-Through - Bulk IP Address Allocation (Netbox)
- Bulk IP Address Allocation (Netbox) - Overview
- Bulk IP Address Allocation (Netbox) - Jinja2 Template
- Bulk IP Address Allocation (Netbox) - Pre-Built Workflow
- Bulk IP Address Allocation (Netbox) - JSON Form
- Bulk IP Address Allocation (Netbox) - Workflow
- Bulk IP Address Allocation (Netbox) - Operations Manager
- Bulk IP Address Allocation (Netbox) - Transformation
- Bulk IP Address Allocation (Netbox) - Workflow Modification
- Bulk IP Address Allocation (Netbox) - Operations Manager Part 2
- Bulk IP Address Allocation (Netbox) - Summary
- Itential Cloud Use Case Walk-Through - Cloud Managed Network (Meraki)
- Cloud Managed Network (Meraki) - Overview
- Cloud Managed Network (Meraki) - Pre-Built Installation
- Cloud Managed Network (Meraki) - JSON Forms
- Cloud Managed Network (Meraki) - Transformation
- Cloud Managed Network (Meraki) - Workflows
- Cloud Managed Network (Meraki) - Create an Automation
- Cloud Managed Network (Meraki) - Device Configuration
- Cloud Managed Network (Meraki) - Summary
- Itential Cloud Use Case Walk-Through - Assign Network & IP (Infoblox)
- Assign Network & IP (Infoblox) - Overview
- Assign Network & IP (Infoblox) - Pre-Built Resources
- Assign Network & IP (Infoblox) - JSON Form
- Assign Network & IP (Infoblox) - Transformation
- Assign Network & IP (Infoblox) - Workflow
- Assign Network & IP (Infoblox) - Operations Manager
- Assign Network & IP (Infoblox) - Summary
- Itential Cloud Use Case Walk-Through - Create a DNS A Record (Infoblox)
- Create a DNS A Record (Infoblox) - Overview
- Create a DNS A Record (Infoblox) - Jinja2 Templates
- Create a DNS A Record (Infoblox) - Pre-Builts
- Create a DNS A Record (Infoblox) - JSON Forms
- Create a DNS A Record (Infoblox) - Transformation
- Create a DNS A Record (Infoblox) - Workflows
- Create a DNS A Record (Infoblox) - Operations Manager
- Create a DNS A Record (Infoblox) - Summary
- Itential Cloud Use Case Walk-Through - Managing the Lifecycle of a Service (IOS)
- Managing the Lifecycle of a Service (IOS) - Overview
- Managing the Lifecycle of a Service (IOS) - Pre-Built Resources
- Managing the Lifecycle of a Service (IOS) - Configuration Manager (Part 1)
- Managing the Lifecycle of a Service (IOS) - Workflows
- Managing the Lifecycle of a Service (IOS) - Lifecycle Manager (Part 1)
- Managing the Lifecycle of a Service (IOS) - Configuration Manager (Part 2)
- Managing the Lifecycle of a Service (IOS) - Lifecycle Manager (Part 2)
- Managing the Lifecycle of a Service (IOS) - Summary
- Itential Cloud Use Case Walk-Through - Golden Configuration (IOS) 2023.1
- Itential Cloud Use Case Walk-Through - Create and Update Incident (ServiceNow) (2023.1)
- Create and Update Incident (ServiceNow) - Overview
- Create and Update Incident (ServiceNow) - Configuration Manager
- Create and Update Incident (ServiceNow) - Jinja2 Templates
- Create and Update Incident (ServiceNow) - JSON Forms
- Create and Update Incident (ServiceNow) - Transformations
- Create and Update Incident (ServiceNow) - Workflow
- Create and Update Incident (ServiceNow) - Operations Manager
- Create and Update Incident (ServiceNow) - Summary
- Itential Cloud Use Case Walk-Through - Create and Update Change Request (ServiceNow) 2023.1
- Create and Update Change Request (ServiceNow) - Overview
- Create and Update Change Request (ServiceNow) - Jinja2 Template
- Create and Update Change Request (ServiceNow) - JSON Form
- Create and Update Change Request (ServiceNow) - Transformation
- Create and Update Change Request (ServiceNow) - Workflow
- Create and Update Change Request (ServiceNow) - Operations Manager
- Create and Update Change Request (ServiceNow) - Summary
- 18 Oct 2024
-
DarkLight
-
PDF
modify
- Updated on 18 Oct 2024
-
DarkLight
-
PDF
modify Task Purpose
The modify task creates a new variable from a modified copy of an existing variable. Its primary purpose is to modify an object key's boolean, number, or string value. Modify can create a new variable from both job and tasks' outgoing variables. It works with boolean, number, string, and object data types. It does not work against array data types, and it will not modify elements of an array in an object.
Properties
Incoming | Description |
---|---|
object_to_update (required) |
Specify the variable to modify. You can modify job variables, a static value that can be useful when testing, or an earlier task's outgoing variable. |
query (optional) |
If not using a query, set its reference task to static and delete the contents of its reference variable. When modifying values that have data types of boolean, number, or string, the incoming variable query is not used. If modifying values of object type and you only need to modify a field, specify a query for that field. See example below. |
new_value (required) |
The new value can come from a job variable, a static value, or an earlier task's outgoing variable. The new value will replace the value passed in the object_to_update parameter, but if object_to_update is an object and you specify a query, the new value will only replace the matching field. See example below. |
Outgoing | Description |
---|---|
updated_object |
The modified value is assigned to immutable variable updated_object and returned to the job. Optionally click the Job Variables check box to create a job variable from updated_object . The immutable variable updated_object remains, and a new mutable job variable is created. HINT: When creating a job variable, provide a new name to avoid name conflicts and provide clarity. |
Example
-
Change boolean value of a job variable or a previous task's outgoing variable having a value of false. The value of
updated_object
(outgoing variable) will be true.object_to_update = <name of var> query = "" new_value = true
JavaScript -
Change string value of a job variable or a previous task's outgoing variable having a value of "before". The value of
updated_object
(outgoing variable) will beafter
.object_to_update = <name of var> query = "" new_value = "after"
JavaScript -
Change boolean value of "sync-status" field in a specified object having a value of true.
object_to_update = { "name": "cr1.atl", "sync-status": true } query = "sync-status" new_value = false
JavaScriptThe value of
updated_object
(outgoing variable) will look like this:{ "name": "cr1.atl", "sync-status": false }
JSON -
Change string value of "description" field in specified object having value of "Northeast region."
object_to_update = { "name": "BMW-1", "description": "Northeast region", "endpoints": [ { "name": "NYC", "device": "er1.nyc" }, { "name": "BOS", "device": "er1.bos" } ] } query = "description" new_value = "New England Region"
JavaScript -
The value of
updated_object
(outgoing variable) will look like this:{ "name": "BMW-1", "description": "New England Region", "endpoints": [ { "name": "NYC", "device": "er1.nyc" }, { "name": "BOS", "device": "er1.bos" } ] }
JSON