Manage custom modules

Prerequisites

Familiarize yourself with module quota limits. For more information, see Limits.

Create a custom module

1. Log in to the Resource Orchestration Service (ROS) console.

2. In the left-side navigation pane, choose Resources > My Modules.

3. On the My Modules page, click Create Module.

4. On the Create Module page, enter the ROS module content.

   For more information about module content, see Develop a module.

   You can use the ROS online editor to edit the template content. For more information, see Use the ROS online editor to write a template.

5. In the upper-right corner of the Create Module page, choose Import/Save Module > Save as New Module.

6. In the Save as New Module dialog box, select Whether Shared, and enter the Module Name and Module Description.

7. Click OK.

View a custom module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the target module in the Module Name column.

   On the module details page, you can:

   • View the Module Details and Version Information.

   • In the Version Information section, click the drop-down list next to Module Version, select a version, and view the Version content.

   • Click the Module content tab to view the module content.

   • Click the Property tab to view the module parameters.

   • Click the Return values tab to view the outputs of the module.

   • Click the Sample Templates tab to view usage examples.

   For more information about properties, return values, and sample templates, see View resource types.

View registration records

1. In the left-side navigation pane, choose Resources > Registration Records.

2. On the Registration Records page, view module registration information.

   Note

   You can filter records by resource type and state.

Edit a custom module

Create a new module version

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, find the target module and click Edit in the Actions column.

3. Edit the module content.

4. In the upper-right corner of the page, choose Import/Save Module > Save as New Version.

5. In the Save as New Version dialog box, enter a Module Description.

6. Click OK.

   The new version appears in the Latest Version column on the My Modules page.

   Note

   If you create a new version, templates that use this module and specify Version as latest may be affected.

Delete a module version

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the target module in the Module Name column.

3. In the Module Details section, click Set default version next to Default version.

4. In the Set default version dialog box, find the version that you want to delete and click Delete in the Actions column.

5. In the Are you sure you want to delete this version? dialog box, click Delete.

   Note

   • You cannot delete the default version.

   • If you delete a version, it can no longer be used in ROS.

   • If you delete the latest version, templates that use this module and specify Version as latest may be affected.

Change the default module version

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the target module in the Module Name column.

3. In the Module Details section, click Set default version next to Default version.

4. In the Set default version dialog box, find the version that you want to set as the default and click Set as Default in the Actions column.

5. Click OK.

   The new default version appears in the Default version field on the My Modules page.

   Note

   If you change the default version, templates that use this module and specify Version as default may be affected.

Edit module description

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the target module in the Module Name column.

3. In the Module Details section, click Edit next to Module Description.

4. In the Edit module description dialog box, update the Module Description.

5. Click OK.

   The updated description appears in the Description column on the My Modules page.

Edit version description

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the target module in the Module Name column.

3. In the Module Details section, click Edit next to Version Description.

4. In the Edit version description dialog box, update the Version Description.

5. Click OK.

Delete a custom module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, find the target module and click Delete in the Actions column.

3. In the Are you sure you want to delete this module? dialog box, click Delete.

   Note

   A deleted module can no longer be used in ROS.