{"id":7764,"date":"2019-01-15T06:31:51","date_gmt":"2019-01-14T20:31:51","guid":{"rendered":"https:\/\/nsrd.info\/blog\/?p=7764"},"modified":"2019-01-15T06:32:39","modified_gmt":"2019-01-14T20:32:39","slug":"basics-using-nsradmin-with-networker-policies","status":"publish","type":"post","link":"https:\/\/nsrd.info\/blog\/2019\/01\/15\/basics-using-nsradmin-with-networker-policies\/","title":{"rendered":"Basics \u2013 Using nsradmin with NetWorker Policies"},"content":{"rendered":"\n

NetWorker 9 saw the introduction of the service-catalogue like Policy\/Workflow\/Action<\/em> configuration engine in NetWorker, which replaced the previous group based configuration. While policies could be manipulated from within NMC, and from the command line using nsrpolicy<\/em>, they couldn’t really be edited (unless you were feeling particularly brave) in nsradmin<\/em> because they’re maintained in JSON format.<\/p>\n\n\n\n

\"\"

<\/figcaption><\/figure>\n\n\n\n

NetWorker 18.2 has introduced an updated nsradmin<\/em> utility though that can be used to manipulate NetWorker Protection Policies, Workflows and Actions, and in this blog post, I’m going to take you through how that works.<\/p>\n\n\n\n

CAUTION<\/strong>: I’ve always said that an advanced NetWorker administrator should be fluent with nsradmin. However, nsradmin lets you directly edit NetWorker resources, so if you’re not sure about what you’re doing, you should always practice on a test server first. Remember you can always run up a temporary NetWorker server and use it in ‘trial’ mode without enablers for a few weeks.<\/p>\n\n\n\n

Let’s check out what the resource types are with NetWorker 18.2:<\/p>\n\n\n\n

\"\"
NetWorker Resource Types<\/figcaption><\/figure>\n\n\n\n

Here you’ll see the NSR\u00a0Protection\u00a0Policy<\/em>, but no workflows or actions. Is that correct? Well, yes. The reason for this is that there’s some interpretation work going on in the background. But don’t worry, we’ll run through what that means. To start with, let’s look at one of my protection policies. Now, I have a ‘Platinum’ protection policy, and I can see its details as follows:<\/p>\n\n\n\n

nsradmin> print type: NSR Protection Policy; name: Platinum<\/strong>
                         type: NSR Protection Policy;
                         name: Platinum;
                      comment: \"Template policy: Platinum\";
         restricted data zone: ;
          Notification action: nsrlog -f policy_notifications.log;
      Notification execute on: completion;
     policy protection period: ;
                 manual saves: No;<\/pre>\n\n\n\n
Using nsradmin to manipulate policies, workflows and actions is covered in the NetWorker 18.2 Administration Guide, so I’m going to more briefly introduce what you need to do here to get to a workflow. Let’s start by finding out what workflows I have in the Platinum<\/em> policy. I’ll use the ‘show’ command to only show the workflow names, then execute the print command:<\/p>\n\n\n\n
nsradmin> show name:<\/strong>
nsradmin> print type: NSR Protection Policy Workflow; policy name: Platinum<\/strong>
                         name: Servers;

                         name: VM Filesystem Backups;

                         name: Laptops; 

                         name: Desktops; 

                         name: iTunes; 

                         name: Uni;
<\/pre>\n\n\n\n
So we’re using a ‘hidden’ resource name called “NSR Protection Policy Workflow”, and to identify the workflows that we want to use, we characterise them by a resource key of “policy name”, being Platinum.<\/p>\n\n\n\n
Let’s drill down and have a look at one of those workflows, the Servers<\/em> workflow.<\/p>\n\n\n\n
nsradmin> show<\/strong>
Will show all attributes
nsradmin> print type: NSR protection policy workflow; name: Servers; policy name: Platinum<\/strong>
                         type: NSR protection policy workflow;
                         name: Servers;
                      comment: ;
           Auto start enabled: Yes;
            Interval end time: \"23:00\";
                        Group: Platinum_Servers;
                     Interval: \"24:00\";
               Restart window: \"24:00\";
                   Start time: \"23:00\";
                      Enabled: Yes;
                  policy name: Platinum;
          Notification action: \"\/bin\/mail -s \\\"Servers Completion Notice\\\"\";<\/pre>\n\n\n\n
Now, what if we wanted to look at the actions that are present for this workflow? Using the ‘show’ command first again to restrict our view to just the names, the command will look like:<\/p>\n\n\n\n
nsradmin> show name  <\/strong>                                     
nsradmin> print type: NSR protection policy action; policy name: Platinum; workflow name: Servers<\/strong>
                         name: backup; 

                         name: clone;<\/pre>\n\n\n\n
Let’s look at the backup action, shall we?<\/p>\n\n\n\n
nsradmin> show<\/strong>
Will show all attributes
nsradmin> print type: NSR protection policy action; policy name: Platinum; workflow name: Servers; name: backup
<\/strong>                         type: NSR protection policy action;
                         name: backup;
                      comment: ;
               action enabled: Yes;
                  policy name: Platinum;
                workflow name: Servers;
                   Concurrent: No;
                  action type: backup;
               Backup subtype: traditional;
           Force backup level: ;
                       period: week;
                      Actions: \"incr,incr,incr,incr,incr,incr,full\";
     Destination storage node: nsrserverhost;
             Destination pool: Backup_01;
                    Retention: 2 Months;
      Apply DD retention lock: No;
            Success threshold: success;
          Client can override: clientCanOverride;
               action retries: 1;
                  Retry delay: 15;
    action inactivity timeout: 30;
           action parallelism: 100;
               Failure impact: continue;
                   Soft limit: \"00:00\";
                   Hard limit: \"00:00\";
          Notification action: \\
 \"\/root\/bin\/mailer.pl  -s \\\"[NetWorker] Servers Backup Results\\\"\";
      Notification execute on: completion;
                    Overrides: ;
                   start time: ;
       DD retention lock time: ;
                    Driven by: ;<\/pre>\n\n\n\n
Here we can see the individual action associated with the policy and workflow. Like any normal nsradmin<\/em> situation, we can edit these resources, too. For instance, let’s say I wanted to reduce the action parallelism from 100 down to 80:<\/p>\n\n\n\n
nsradmin> update action parallelism: 80<\/strong>
           action parallelism: 80;
Update? y<\/strong>
184066:nsradmin: 'Platinum \/ Servers \/ backup' Action will be updated
nsradmin> print<\/strong>
                         type: NSR protection policy action;
                         name: backup;
                      comment: ;
               action enabled: Yes;
                  policy name: Platinum;
                workflow name: Servers;
                   Concurrent: No;
                  action type: backup;
               Backup subtype: traditional;
           Force backup level: ;
                       period: week;
                      Actions: \"incr,incr,incr,incr,incr,incr,full\";
     Destination storage node: nsrserverhost;
             Destination pool: Backup_01;
                    Retention: 2 Months;
      Apply DD retention lock: No;
            Success threshold: success;
          Client can override: clientCanOverride;
               action retries: 1;
                  Retry delay: 15;
    action inactivity timeout: 30;
           action parallelism: 80;
               Failure impact: continue;
                   Soft limit: \"00:00\";
                   Hard limit: \"00:00\";
          Notification action: \\
 \"\/root\/bin\/mailer.pl  -s \\\"[NetWorker] Servers Backup Results\\\"\";
      Notification execute on: completion;
                    Overrides: ;
                   start time: ;
       DD retention lock time: ;
                    Driven by: ;<\/pre>\n\n\n\n
Now, what if I wanted to create an entirely new workflow for my ‘Platinum’ policy? Since NetWorker will automatically fill in defaults for resources, we can create a ‘templated’ workflow very easily that we can then adjust. For instance:<\/p>\n\n\n\n
nsradmin> create type: NSR protection policy workflow; name: Demo; policy name: Platinum<\/strong>
                         type: NSR protection policy workflow;
                         name: Demo;
                  policy name: Platinum;
Create? y<\/strong>
183936:nsradmin: 'Platinum \/ Demo' workflow was successfully created
nsradmin> print type: NSR protection policy workflow; name: Demo; policy name: Platinum<\/strong>
                         type: NSR protection policy workflow;
                         name: Demo;
                      comment: ;
           Auto start enabled: Yes;
            Interval end time: \"21:00\";
                        Group: ;
                     Interval: \"24:00\";
               Restart window: \"12:00\";
                   Start time: \"21:00\";
                      Enabled: Yes;
                  policy name: Platinum;
          Notification action: \" \";<\/pre>\n\n\n\n
Since I don’t really need that workflow, I can equally delete it. Because it’s still the target of my previous print command in my session, that’s as simple as:<\/p>\n\n\n\n
nsradmin> delete<\/strong>
                         type: NSR protection policy workflow;
                         name: Demo;
                      comment: ;
           Auto start enabled: Yes;
            Interval end time: \"21:00\";
                        Group: ;
                     Interval: \"24:00\";
               Restart window: \"12:00\";
                   Start time: \"21:00\";
                      Enabled: Yes;
                  policy name: Platinum;
          Notification action: \" \";
 Delete? y<\/strong>
 183985:nsradmin: Platinum \/ Demo Workflow deleted successfully<\/pre>\n\n\n\n
(If you’re unsure, you’d always fully target the resource you want to delete, but nsradmin will prompt you to confirm as long as you’re working against a NetWorker server in interactive mode.)<\/p>\n\n\n\n
And there you have it: using nsradmin to manipulate Policies, Workflows and Actions in NetWorker 18.2. That’s yet another good reason to make sure you upgrade ASAP, as far as I’m concerned!<\/p>\n","protected":false},"excerpt":{"rendered":"
NetWorker 9 saw the introduction of the service-catalogue like Policy\/Workflow\/Action configuration engine in NetWorker, which replaced the previous group based…<\/p>\n","protected":false},"author":1,"featured_media":7788,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[6,16,17],"tags":[1380,1201,1249,653,1501,1379],"class_list":["post-7764","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-basics","category-networker","category-policies","tag-action","tag-command-line","tag-networker","tag-nsradmin","tag-protection-policy","tag-workflow"],"aioseo_notices":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"https:\/\/nsrd.info\/blog\/wp-content\/uploads\/2019\/01\/bigStock-Using-a-Keyboard.jpg","jetpack_shortlink":"https:\/\/wp.me\/pKpIN-21e","jetpack_sharing_enabled":true,"jetpack_likes_enabled":true,"_links":{"self":[{"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/posts\/7764","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/comments?post=7764"}],"version-history":[{"count":3,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/posts\/7764\/revisions"}],"predecessor-version":[{"id":7791,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/posts\/7764\/revisions\/7791"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/media\/7788"}],"wp:attachment":[{"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/media?parent=7764"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/categories?post=7764"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/nsrd.info\/blog\/wp-json\/wp\/v2\/tags?post=7764"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}